octave-nkf: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 19441:86e69f51328d

genpropdoc.m: Use two spaces after period at start of sentence. * genpropdoc.m: Use two spaces after period at start of sentence.

author	Rik <rik@octave.org>
date	Tue, 16 Dec 2014 15:50:37 -0800
parents	346b20b2c2ff
children	db92e7e28e1f

rev	line source
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1 ## Copyright (C) 2014 Pantxo Diribarne
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2 ##
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.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	7 ##
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.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	12 ##
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
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	17 ## -- texinfo --
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	18 ## @deftypefn {Function File} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	19 ##
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	20 ## Print FILENAME texinfo source file associated to OBJNAME objects.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	21 ## This function is meant to be run for generating octave
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	22 ## documentation (see doc/interpreter/graphics_properties.mk).
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	23 ##
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	24 ## All the hard coded documentation is written in getdoc
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	25 ## function. See the comments in getdoc bellow for instruction on how
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	26 ## to document a graphics property.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	27 ##
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
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	31 function genpropdoc (objname, fname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	32 objnames = {"root", "figure", "axes", "line", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	33 "text", "image", "patch", "surface"};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	34
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	35 ## Base properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	36 base = getstructure ("base");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	37
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	38 ## Object properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	39 if (any (strcmp (objname, objnames)))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	40 obj = getstructure (objname, base);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	41 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	42 error ("genpropdoc: unknown object %s", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	43 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	44
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	45 ## Docstring
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	46 str = printdoc (objname, obj);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	47
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	48 fid = fopen (fname, "w+");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	49 if (fid < 0)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	50 error ("genpropdoc: couldn't open %s.", fname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	51 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	52
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	53 fprintf (fid, str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	54 fclose (fid);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	55 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	56
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	57 function s = getdoc (objname, field, base)
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	58 ## Properties are represented by a struct with fields :
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	59 ##
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	60 ## -"doc": string to be printed verbatim after being expanded
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	61 ## through expand_doc function. Special keywords are:
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	62 ## "__objname__" further replaced by the current object name;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	63 ## "__prop__" further replaced by the current property name;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	64 ## "__modemsg__" further replaced by a message explaining that
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	65 ## the propmode will be toggled to "manual".
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	66 ## You may also cross reference properties using the label format
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	67 ## OBJNAMEPROPERTY, e.g, "@xref{XREFaxescolor, , axes color
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	68 ## property}."
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	69 ##
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	70 ## -"valid": string that describes valid values for the
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	71 ## current property. Use "packopt" function to join options with
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	72 ## " \| " separator and "markdef" to mark default among valid
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	73 ## values between curly braces.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	74 ## If not provided, valid values for radio properties are
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	75 ## automatically retrieved using set function.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	76 ##
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	77 ## -"default": string. If not provided the default value is
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	78 ## automatically retrieved using get function.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	79 ##
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	80 ## -"printdefault": a boolean (def. true) that specifies whether the
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	81 ## default value should be printed. It is useful for properties
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	82 ## like root "screendepth" that default to screen dependant values.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	83
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	84 packopt = @(c) strjoin (c, ' \| ');
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	85 markdef = @(s) ["@{" s "@}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	86
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	87 ## Some generic templates:
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	88 valid_color = "colorspec";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	89 valid_handle = "graphics handle";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	90 valid_string = "string";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	91 valid_fcn = packopt ({"string", "function handle"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	92 valid_cellstring = packopt ({"string", "cell array of strings"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	93 valid_2elvec = "two elements vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	94 valid_3elvec = "three elements vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	95 valid_4elvec = "four elements vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	96 valid_vecmat = packopt ({"vector", "matrix"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	97 valid_scalmat = packopt ({"scalar", "matrix"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	98
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	99 doc_notimpl = "%s is not yet implemented for __objname__ \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	100 objects. __prop__ is unused.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	101 doc_unused = "__prop__ is unused.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	102
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	103
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	104 ## Initialize structure
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	105 if (isfield (base, field))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	106 s = base.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	107 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	108 s = struct ("valid", "", "default", "", "doc", "", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	109 "printdefault", true);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	110 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	111
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	112 ## Base properties: write generic documentation as it will, by
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	113 ## default, be included in the list of each graphics object.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	114 ## If a given graphics object interprets the property differently
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	115 ## than most others, the doc will have to be rewritten for this object.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	116 if (strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	117 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	118 case "beingdeleted"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	119 case "busyaction"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	120 case "buttondownfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	121 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	122 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	123 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	124 s.valid = "vector of graphics handles";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	125
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	126 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	127 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	128 clipped in its parent axes limits.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	129
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	130 case "createfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	131 s.doc = "Callback functions to be executed right after \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	132 the __objname__ has been created. Those functions have to be set by \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	133 default using e.g. @code{set (0, \"default__objname__createfcn\", \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	134 'disp (\"__objname__ created!\")') }.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	135 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	136
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	137 case "deletefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	138 s.doc = "Callback functions to be executed right before \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	139 the __objname__ is deleted.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	140 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	141
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	142 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	143 s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__'s \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	144 handle is not visible into its parent's children list.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	145
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	146 case "hittest"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	147 case "interruptible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	148 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	149 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	150 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	151
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	152 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	153 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	154 case "tag"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	155 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	156
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	157 case "type"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	158 s.doc = "Class name of the graphics object. __prop__ is \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	159 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	160 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	161 s.printdefault = false;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	162
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	163 case "uicontextmenu"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	164 case "userdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	165 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	166 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	167 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	168 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	169
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	170 ## Root properties:
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	171 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	172 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	173 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	174 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	175 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	176 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	177 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	178 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	179
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	180 case "parent"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	181 s.doc = "Root figure has no parent graphics object. __prop__ \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	182 is always empty.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	183
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	184 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	185 case "callbackobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	186 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	187
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	188 case "commandwindowsize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	189 case "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	190 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	191 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	192
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	193 case "diary"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	194 s.doc = "If __prop__ is @qcode{\"on\"}, the octave \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	195 command window session is saved to file. @xref{XREFrootdiaryfile, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	196 diaryfile property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	197 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	198
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	199 case "diaryfile"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	200 s.doc = "The name of the diary file. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	201 @xref{XREFdiary, , diary function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	202 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	203
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	204 case "echo"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	205 s.doc = "Control whether octave displays commands executed \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	206 from scripts. @xref{XREFecho, , echo function}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	207
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	208 case "errormessage"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	209 s.doc = "The last error message octave raised. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	210 @xref{XREFlasterr, , lasterr function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	211 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	212
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	213 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	214 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	215
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	216 case "format"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	217 s.doc = "This property is a wrapper around @code{format} \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	218 function. @xref{XREFformat, , format function}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	219
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	220 case "formatspacing"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	221 s.doc = "This property is a wrapper around @code{format} \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	222 function. @xref{XREFformat, , format function}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	223
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	224 case "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	225 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	226
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	227 case "monitorpositions"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	228 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	229
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	230 case "pointerlocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	231 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	232
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	233 case "pointerwindow"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	234 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	235
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	236 case "recursionlimit"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	237 s.doc = "The maximum number of times a function can be \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	238 called recursively. @xref{XREFmax_recursion_depth, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	239 max_recursion_depth function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	240 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	241
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	242 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	243 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	244 s.printdefault = false;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	245
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	246 case "screenpixelsperinch"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	247 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	248 s.printdefault = false;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	249
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	250 case "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	251 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	252 s.printdefault = false;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	253
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	254 case "showhiddenhandles"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	255 s.doc = "If __prop__ is @qcode{\"on\"}, all graphics objects \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	256 handle are visible in their parents' children list, regardless of \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	257 the value of their @code{handlevisibility} property.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	258
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	259 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	260 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	261
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	262 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	263 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	264 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	265 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	266 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	267 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	268
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	269 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	270 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	271 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	272 case "closerequestfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	273 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	274
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	275 case "color"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	276 s.doc = "Color of the figure background. @xref{Colors, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	277 colorspec}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	278 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	279
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	280 case "colormap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	281 s.doc = "A matrix containing the RGB color map for \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	282 the current axes.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	283 s.valid = "N-by-3 matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	284
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	285 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	286 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	287 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	288
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	289 case "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	290 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	291
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	292 case "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	293 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	294
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	295 case "currentpoint"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	296 s.doc = "A 1-by-2 matrix which holds the coordinates of \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	297 the point over which the mouse pointer was when a mouse event \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	298 occurred. The x and y coordinates are in units defined by the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	299 figures @qcode{\"units\"} property and their origin is the lower \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	300 left corner of the plotting area.\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	301 \n\nEvents which set @qcode{\"currentpoint\"} are\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	302 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	303 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	304 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	305 @item A mouse button was released\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	306 only if the figures callback @qcode{\"windowbuttonupfcn\"} is defined\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	307 @item The pointer was moved while pressing mouse button (drag)\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	308 only if the figures callback @qcode{\"windowbuttonmotionfcn\"} is \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	309 defined \n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	310 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	311 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	312
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	313 case "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	314 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	315
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	316 case "doublebuffer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	317 case "filename"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	318 case "integerhandle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	319 case "inverthardcopy"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	320 case "keypressfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	321 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	322
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	323 case "keyreleasefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	324 s.doc = "With @code{keypressfcn}, the keyboard callback \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	325 functions. These callback functions get called when a key is \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	326 pressed/released respectively. The functions are called with two \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	327 input arguments. The first argument holds the handle of the calling \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	328 figure. The second argument holds the event structure which has the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	329 following members:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	330 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	331 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	332 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	333 @item Key:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	334 lowercase value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	335 @item Modifier:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	336 A cell array containing strings representing the modifiers pressed \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	337 with the key.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	338 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	339 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	340
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	341 case "menubar"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	342 case "mincolormap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	343 case "name"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	344 s.doc = "Name to be displayed in the figure title bar. If \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	345 __prop__ is empty, the title of the figure is \"figure\" followed \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	346 by the figure handle value.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	347 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	348
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	349 case "nextplot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	350 case "numbertitle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	351 case "outerposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	352 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	353
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	354 case "paperorientation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	355 case "paperposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	356 s.doc = "Vector @qcode{[x0 y0 width height]} defining the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	357 position of the figure (in @code{paperunits} units) in the printed \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	358 page. __modemsg__.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	359 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	360
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	361 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	362 s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	363 @qcode{\"paperposition\"} property is automatically computed: the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	364 printed figure will have the same size as on-screen figure and will \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	365 be centered in the output page.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	366 case "papersize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	367 s.doc = "Vector @qcode{[width height]} defining the size of the \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	368 printing paper. Setting this property forces the @code{papertype} \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	369 property to be set to @qcode{\"<custom>\"}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	370 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	371
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	372 case "papertype"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	373 s.doc = "Name of the paper to be used for printed output. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	374 Setting __prop__ also changes @code{papersize} accordingly.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	375
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	376 case "paperunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	377 s.doc = "The unit used to compute the @code{paperposition} \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	378 property.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	379
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	380 case "pointer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	381 case "pointershapecdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	382 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	383
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	384 case "pointershapehotspot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	385 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	386
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	387 case "position"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	388 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	389
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	390 case "renderer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	391 case "renderermode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	392 case "resize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	393 case "resizefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	394 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	395
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	396 case "selectiontype"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	397 case "toolbar"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	398 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	399 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	400 @code{outerposition} properties.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	401 case "windowbuttondownfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	402 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	403 windowbuttonupfcn property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	404 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	405
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	406 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	407 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	408 windowbuttonupfcn property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	409 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	410
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	411 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	412 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	413 @code{windowbuttonmotionfcn}, the mouse callback functions. These \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	414 callback functions get called when the mouse button is pressed, \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	415 dragged, and released respectively. When these callback functions \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	416 are called, the @code{currentpoint} property holds the current \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	417 coordinates of the cursor.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	418 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	419
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	420 case "windowkeypressfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	421 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	422
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	423 case "windowkeyreleasefcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	424 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	425
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	426 case "windowscrollwheelfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	427 s.valid = valid_fcn;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	428
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	429 case "windowstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	430 case "wvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	431 case "wvisualmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	432 case "xdisplay"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	433 case "xvisual"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	434 case "xvisualmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	435 case "__graphics_toolkit__"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	436 s.doc = "The graphics toolkit that is used to render the \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	437 figure. @xref{XREFavailable_graphics_toolkits, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	438 available_graphics_toolkits function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	439 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	440
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	441 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	442 elseif (strcmp (objname, "axes"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	443 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	444 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	445 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	446 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	447
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	448 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	449 case "activepositionproperty"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	450 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	451 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	452 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	453 case "ambientlightcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	454 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	455 case "box"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	456 s.doc = "Control wether the axes has a surrounding box.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	457
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	458 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	459 s.valid = valid_3elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	460
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	461 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	462 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	463 s.valid = valid_3elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	464
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	465 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	466 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	467 s.valid = valid_3elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	468
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	469 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	470 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	471 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	472
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	473 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	474 case "clim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	475 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	476 s.doc = "Define the limits for the color axis of image \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	477 children. __modemsg__. @xref{XREFpcolor, , pcolor function}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	478
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	479 case "climmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	480 case "color"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	481 s.doc = "Color of the axes background. @xref{Colors, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	482 colorspec}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	483 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	484
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	485 case "colororder"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	486 s.doc = "RGB values to be used by plot function for \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	487 automatic line coloring.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	488 s.valid = "N-by-3 RGB matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	489
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	490 case "currentpoint"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	491 s.doc = "Matrix @qcode{[xf, yf, zf; xb, yb, zb]} which holds \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	492 the coordinates of the point over which the mouse pointer was when \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	493 the mouse button was pressed in axes data units. If a mouse \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	494 callback function is defined, @code{currentpoint} holds the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	495 pointer coordinates at the time the mouse button was pressed. For \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	496 3D plots, the first row of the returned matrix specifies the point \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	497 nearest to the current camera position and the second rows the \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	498 furthest point. The two points forms a line which is perpendicular \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	499 to the screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	500 s.valid = "2-by-3 matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	501
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	502 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	503 s.doc = "Specify the relative height and width of the data \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	504 displayed in the axes. Setting @code{dataaspectratio} to @samp{[1, \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	505 2]} causes the length of one unit as displayed on the y-axis to be \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	506 the same as the length of 2 units on the x-axis. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	507 s.valid = valid_3elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	508
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	509 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	510 case "drawmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	511 case "fontangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	512 case "fontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	513 s.doc = "Name of the font to be used for axes annotations.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	514 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	515
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	516 case "fontsize"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	517 s.doc = "Size of the font to be used for axes annotations. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	518 @xref{XREFaxesfontunits, , fontunits property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	519 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	520
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	521 case "fontunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	522 s.doc = "Unit used to interpret @code{fontsize} property.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	523
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	524 case "fontweight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	525 case "gridlinestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	526 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	527 case "layer"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	528 case "linestyleorder"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	529 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	530 case "minorgridlinestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	531 case "nextplot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	532 case "outerposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	533 s.doc = "Specify the position of the plot, including titles, \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	534 axes and legend. The four elements of the vector are the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	535 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	536 plot, in units normalized to the width and height of the plot \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	537 window. For example, @qcode{[0.2, 0.3, 0.4, 0.5]} sets the lower \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	538 left corner of the axes at @math{(0.2, 0.3)} and the width and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	539 height to be 0.4 and 0.5 respectively. @xref{XREFaxesposition, , position property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	540 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	541
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	542 case "plotboxaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	543 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	544 case "position"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	545 s.doc = "Specify the position of the plot, excluding titles, \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	546 axes and legend. The four elements of the vector are the \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	547 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	548 plot, in units normalized to the width and height of the plot \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	549 window. For example, @qcode{[0.2, 0.3, 0.4, 0.5]} sets the lower \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	550 left corner of the axes at @math{(0.2, 0.3)} and the width and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	551 height to be 0.4 and 0.5 respectively. @xref{XREFaxesouterposition, , \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	552 outerposition property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	553 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	554
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	555 case "projection"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	556 case "tickdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	557 case "tickdirmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	558 case "ticklength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	559 case "tightinset"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	560 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	561 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	562 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	563
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	564 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	565 case "view"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	566 s.doc = "Specify the view point for three-dimensional plots";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	567 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	568
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	569 case "xaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	570 case "xcolor"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	571 s.doc = "Color of the x-axis. @xref{Colors, , colorspec}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	572 s.valid = packopt ({markdef(valid_color), ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	573 "@qcode{\"none\"}"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	574
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	575 case "xdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	576 case "xgrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	577 s.doc = "Control wether major x grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	578
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	579 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	580 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	581 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	582
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	583 case "xlim"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	584 s.doc = "Specify the limits for x-axis. __modemsg__. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	585 @xref{XREFxlim, , xlim function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	586 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	587
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	588 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	589 case "xminorgrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	590 s.doc = "Control wether minor x grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	591
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	592 case "xminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	593 case "xscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	594 case "xtick"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	595 s.doc = "Position of x tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	596 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	597
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	598 case "xticklabel"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	599 s.doc = "Labels of x tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	600 s.valid = valid_cellstring;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	601
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	602 case "xticklabelmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	603 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	604 case "yaxislocation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	605 case "ycolor"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	606 s.doc = "Color of the y-axis. @xref{Colors, , colorspec}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	607 s.valid = packopt ({markdef(valid_color), ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	608 "@qcode{\"none\"}"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	609
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	610 case "ydir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	611 case "ygrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	612 s.doc = "Control wether major y grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	613
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	614 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	615 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	616 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	617
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	618 case "ylim"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	619 s.doc = "Specify the limits for y-axis. __modemsg__. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	620 @xref{XREFylim, , ylim function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	621 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	622
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	623 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	624 case "yminorgrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	625 s.doc = "Control wether minor y grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	626
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	627 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	628 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	629 case "ytick"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	630 s.doc = "Position of y tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	631 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	632
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	633 case "yticklabel"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	634 s.doc = "Labels of y tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	635 s.valid = valid_cellstring;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	636
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	637 case "yticklabelmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	638 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	639 case "zcolor"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	640 s.doc = "Color of the z-axis. @xref{Colors, , colorspec}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	641 s.valid = packopt ({markdef(valid_color), ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	642 "@qcode{\"none\"}"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	643
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	644 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	645 case "zgrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	646 s.doc = "Control wether major z grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	647
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	648 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	649 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	650 s.valid = valid_handle;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	651
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	652 case "zlim"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	653 s.doc = "Specify the limits for z-axis. __modemsg__. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	654 @xref{XREFzlim, , zlim function}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	655 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	656
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	657 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	658 case "zminorgrid"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	659 s.doc = "Control wether minor z grid lines are displayed.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	660
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	661 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	662 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	663 case "ztick"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	664 s.doc = "Position of z tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	665 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	666
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	667 case "zticklabel"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	668 s.doc = "Labels of z tick marks. __modemsg__.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	669 s.valid = valid_cellstring;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	670
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	671 case "zticklabelmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	672 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	673 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	674
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	675 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	676 elseif (strcmp (objname, "line"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	677 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	678 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	679 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	680 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	681
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	682 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	683 case "color"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	684 s.doc = "Color of the line object. @xref{Colors, , \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	685 colorspec}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	686 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	687
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	688 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	689 s.doc = "The text of the legend entry corresponding to this \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	690 line.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	691 s.valid = valid_cellstring;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	692
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	693 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	694 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	695
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	696 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	697 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	698 s.doc = "@xref{Line Styles}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	699
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	700 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	701 s.doc = "Width in points of the line object.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	702
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	703 case "marker"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	704 s.doc = "The shape of the marker to be used. @xref{Marker \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	705 Styles}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	706
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	707 case "markeredgecolor"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	708 s.doc = "Color of the edge of the markers. If set \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	709 @qcode{\"auto\"}, the markers edges have the same color as the line. If \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	710 set @qcode{\"none\"}, the markers edges are not displayed. This property \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	711 can also be set to any color. @xref{Colors, , colorspec}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	712
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	713 case "markerfacecolor"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	714 s.doc = "Color of the face of the markers. If set \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	715 @qcode{\"auto\"}, the markers faces have the same color as the line. If \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	716 set @qcode{\"none\"}, the markers faces are not displayed. This property \
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	717 can also be set to any color. @xref{Colors, , colorspec}.";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	718
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	719 case "markersize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	720 s.doc = "Size of the markers in points.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	721 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	722
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	723 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	724 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	725 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	726
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	727 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	728 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	729 s.doc = "Name of the vector in the current base workspace \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	730 that should be used as x data.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	731
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	732 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	733 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	734 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	735
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	736 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	737 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	738 s.doc = "Name of the vector in the current base workspace \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	739 that should be used as y data.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	740
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	741 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	742 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	743 s.valid = "vector";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	744
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	745 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	746 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	747 s.doc = "Name of the vector in the current base workspace \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	748 that should be used as z data.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	749
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	750 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	751
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	752 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	753 elseif (strcmp (objname, "text"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	754 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	755 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	756 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	757 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	758
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	759 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	760 case "backgroundcolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	761 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	762 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	763
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	764 case "color"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	765 s.doc = "Color of the text. @xref{Colors, ,colorspec}. ";
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	766 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	767
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	768 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	769 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	770 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	771 s.valid = valid_color;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	772
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	773 case "editing"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	774 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	775 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	776
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	777 case "extent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	778 case "fontangle"
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	779 s.doc = "Flag whether the font is italic or normal. \
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	780 @code{fontangle} is currently unused.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	781
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	782 case "fontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	783 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	784 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	785
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	786 case "fontsize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	787 s.doc = "The font size of the text.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	788 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	789
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	790 case "fontunits"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	791 s.doc = "The units used to interpret @code{fontsize} \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	792 property.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	793
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	794 case "fontweight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	795 s.doc = "Flag whether the font is bold, etc.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	796
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	797 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	798 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	799 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	800 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	801
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	802 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	803 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	804 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	805
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	806 case "margin"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	807 s.doc = sprintf (doc_notimpl, "Background area");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	808 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	809
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	810 case "position"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	811 s.doc = "Vector @qcode{[X0 Y0 Z0]} where X0, Y0 and Z0 \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	812 indicate the position of the text anchor as defined by \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	813 @code{verticalalignment} and @code{horizontalalignment}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	814 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	815
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	816 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	817 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	818 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	819 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	820
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	821 case "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	822 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	823 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	824
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	825 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	826 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	827 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	828
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	829 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	830 elseif (strcmp (objname, "image"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	831 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	832 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	833 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	834 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	835
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	836 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	837 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	838 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	839 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	840
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	841 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	842 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	843
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	844 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	845 s.valid = "matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	846
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	847 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	848 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	849 s.doc = "The text of the legend entry corresponding to this \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	850 image.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	851 s.valid = valid_cellstring;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	852
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	853 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	854 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	855
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	856 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	857 s.doc = "Two element vector @qcode{[xmin xmax]} specifying the x \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	858 coordinates of the first and last columns of the image. \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	859 \n\nSetting @code{xdata} empty matrix makes octave automatically \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	860 affect it the value @qcode{[1 columns(image)]}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	861 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	862
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	863 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	864 s.doc = "Vector @qcode{[ymin ymax]} specifying the y \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	865 coordinates of the first and last columns of the image. \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	866 \n\nSetting @code{ydata} empty matrix makes octave automatically \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	867 affect it the value @qcode{[1 rows(image)]}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	868 s.valid = valid_2elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	869
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	870 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	871
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	872 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	873 elseif (strcmp (objname, "surface"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	874 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	875 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	876 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	877 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	878
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	879 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	880 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	881 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	882 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	883
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	884 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	885 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	886
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	887 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	888 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	889
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	890 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	891 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	892
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	893 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	894 s.valid = "matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	895
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	896 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	897 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	898 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	899 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	900
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	901 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	902 s.doc = "The text of the legend entry corresponding to this \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	903 surface.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	904
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	905 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	906 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	907 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	908
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	909 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	910 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	911 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	912
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	913 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	914 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	915 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	916 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	917 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	918
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	919 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	920 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	921 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	922
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	923 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	924 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	925 s.doc = "@xref{Line Styles}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	926
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	927 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	928 s.doc = "@xref{XREFlinelinewidth, , line linewidth \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	929 property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	930
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	931 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	932 s.doc = "@xref{Marker Styles}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	933
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	934 case "markeredgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	935 s.doc = "@xref{XREFlinemarkeredgecolor, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	936 markeredgecolor property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	937
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	938 case "markerfacecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	939 s.doc = "@xref{XREFlinemarkerfacecolor, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	940 markerfacecolor property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	941
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	942 case "markersize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	943 s.doc = "@xref{XREFlinemarkersize, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	944 markersize property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	945 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	946
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	947 case "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	948 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	949 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	950 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	951
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	952 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	953 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	954
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	955 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	956 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	957
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	958 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	959 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	960 s.valid = "matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	961
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	962 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	963 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	964 s.valid = "matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	965
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	966 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	967 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	968 s.valid = "matrix";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	970 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	971 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	972
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	973 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	974 elseif (strcmp (objname, "patch"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	975 switch field
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	976 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	977 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	978 s.doc = doc_unused;
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 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	981 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	982 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	983
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	984 case "ambientstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	985 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	986 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	987
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	988 case "backfacelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	989 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	990
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	991 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	992 s.doc = "Data defining the patch object color.\n\
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	993 Patch color can be defined for faces or for vertices. \n\n\
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	994 If @code{cdata} is a scalar index into the current colormap or a RGB \
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	995 triplet, it defines the color of all faces. \n\n\
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	996 If @code{cdata} is a N-by-1 vector of indices or a N-by-3 (RGB) \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	997 matrix, it defines the color of each one of the N faces.\n\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	998 If @code{cdata} is a N-by-M or a N-by-M-by-3 (RGB) \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	999 matrix, it defines the color all vertices.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1000 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1001
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1002 case "diffusestrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1003 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1004 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1005
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1006 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1007 s.doc = "The text of the legend entry corresponding to this \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1008 patch.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1009 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1010 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1011 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1012
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1013 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1014 case "edgelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1015 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1016
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1017 case "erasemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1018 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1019
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1020 case "facealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1021 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1022 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1023
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1024 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1025 ## 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	1026 ## 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	1027 s.valid = packopt ({markdef(valid_color), ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1028 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1029 "@qcode{\"none\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1030 "@qcode{\"interp\"}"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1031
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1032 case "facelighting"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1033 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1034
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1035 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1036 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1037 s.valid = valid_vecmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1038
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1039 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1040 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1041 s.valid = valid_scalmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1042
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1043 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1044 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1045 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1046
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1047 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1048 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1049 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1050 s.doc = "@xref{XREFlinemarker, , line marker property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1051
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1052 case "markeredgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1053 s.doc = "@xref{XREFlinemarkeredgecolor, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1054 markeredgecolor property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1055
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1056 case "markerfacecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1057 s.doc = "@xref{XREFlinemarkerfacecolor, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1058 markerfacecolor property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1059
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1060 case "markersize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1061 s.doc = "@xref{XREFlinemarkersize, , line \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1062 markersize property}.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1063 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1064
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1065 case "normalmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1066 case "specularcolorreflectance"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1067 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1068 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1069
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1070 case "specularexponent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1071 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1072 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1073
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1074 case "specularstrength"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1075 s.doc = sprintf (doc_notimpl, "Light");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1076 s.valid = "scalar";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1077
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1078 case "vertexnormals"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1079 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1080 s.valid = valid_vecmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1081
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1082 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1083 s.valid = valid_vecmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1084
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1085 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1086 s.valid = valid_vecmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1087
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1088 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1089 s.valid = valid_vecmat;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1090
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1091 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1092 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1093
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1094 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1095 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1096 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	1097 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1098
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1099 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1100
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1101 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1102 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1103 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1104
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1105 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	1106 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1107 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1108 strout = strrep (strout, "__modemsg__", modemsg);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1109 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1110
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1111 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1112 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1113 if (! strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1114 ## Use an improbable figure number to avoid ishandle to return
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1115 ## true for 1
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1116 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1117 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1118
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1119 ## Build a default object to extract its properties list and default
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1120 ## values.
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1121 if (strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1122 ## Base properties are extracted from hggroup that only have 2
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1123 ## additional regular (non-hidden) properties, "displayname" and
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1124 ## "erasemode".
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1125 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1126 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1127 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1128 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1129 h = hf;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1130 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1131 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1132 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1133
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1134 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1135 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1136
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1137 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1138 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1139 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1140 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1141 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1143 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1144 val = getdoc (objname, field, base);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1145
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1146 ## 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	1147 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1148 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1149 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1150
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1151 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1152
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1153 ## 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	1154 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1155 val.valid = sprop.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1156 if (! isempty (val.valid) &&
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1157 iscellstr (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1158 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1159 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	1160 "uniformoutput", false);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1161 val.valid = strjoin (val.valid, ' \| ');
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1162 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1163 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1164
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1165 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1166 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1167 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1168
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1169 ## 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	1170 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1171
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1172 if (strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1173 s = rmfield (s, {"displayname", "erasemode"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1174 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1175
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1176 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1177 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1178 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1179 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1180
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1181 function def = getdefault (h, objname, field)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1182 ## 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	1183 ## 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	1184 def = get (h, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1185
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1186 ## 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	1187 if (isscalar (def) && def != 0 && ishandle (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1188 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1189 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1190 if (ischar (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1191 def = ["@qcode{\"" def "\"}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1193 if ((isvector (def) && numel (def) < 5) \|\|
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1194 isempty (def))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1195 ## 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	1196 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1197 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1198 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1199 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1200
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1201 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1202 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1203 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1204 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1205 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1206 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1207 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1208 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1209
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1210 ## Replace texinfo reserved characters
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1211 def = strrep (str, "{", "@{");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1212 def = strrep (def, "}", "@}");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1213 def = strrep (def, "@", "@@");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1214
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1215 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1216 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1217 args = arrayfun (@(x) num2str (x), size (def),
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1218 "uniformoutput", false);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1219 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1220 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1221 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1222 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1223 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1224
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1225 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1226 ## 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	1227 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1228 nf = numel (fields);
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 ## File header and begining of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1231 str = [warn_autogen() "\n\n@table @asis"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1232
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1233
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1234 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1235 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1236 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1237
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1238 ## @anchor: cross reference using XREFobjnamefield label
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1239 ## Concept index: call info from octave with
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1240 ## 'doc ("objname field")'
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1241 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	1242 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1243
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1244 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1245 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	1246
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1247 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1248 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1249 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1250 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1251 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1252 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1253
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1254 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1255 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1256 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1257 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1258 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1259 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1260 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1261 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1262
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1263 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1264 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	1265 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1266
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1267 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1268 str = sprintf ("%s\n@end table", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1269 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1270
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1271 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1272 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	1273 \n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1274 @c Copyright (C) 2014 Pantxo Diribarne\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1275 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1276 @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	1277 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1278 @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	1279 @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	1280 @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	1281 @c your option) any later version.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1282 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1283 @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	1284 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n\
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	1285 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\n\
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1286 @c for more details.\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1287 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1288 @c You should have received a copy of the GNU General Public License\n\
19441 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19357 diff changeset	1289 @c along with Octave; see the file COPYING. If not, see\n\
19291 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1290 @c <http://www.gnu.org/licenses/>.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1291 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1292
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1293 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1294 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1295 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1296 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1297 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1298 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1299 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1300 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1301 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1302 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1303 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1304 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1305 endfunction

Mercurial > octave-nkf

annotate doc/interpreter/genpropdoc.m @ 19441:86e69f51328d