octave: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 25867:49ffa78f9243

Use "facenormals" for flat lighting on surfaces (bug #54024). * graphics.in.h, graphics.cc (surface::properties::update_face_normals): New function. * gl-render.cc (draw_surface): Use face normals if lighting mode is "flat". * genpropdoc.m (surface): Document "facenormals(mode)" and "vertexnormals(mode)". * light.m: Document usage of "facenormals" and "vertexnormals". * NEWS: Announce changes.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Sat, 08 Sep 2018 20:36:30 +0200
parents	fb775d5a626a
children	ea5182364e5f

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24634 diff changeset	1 ## Copyright (C) 2014-2018 Pantxo Diribarne
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2 ##
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	3 ## This file is part of Octave.
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	4 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	8 ## (at your option) any later version.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	9 ##
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	12 ## 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	13 ## GNU General Public License for more details.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	14 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	17 ## <https://www.gnu.org/licenses/>.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	18
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	19 ## -- texinfo --
21319 8880d93010d8 Remove further uses of CLASS field in @deftypefn macro. Rik <rik@octave.org> parents: 20930 diff changeset	20 ## @deftypefn {} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	21 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	22 ## Print FILENAME texinfo source file associated to OBJNAME objects. This
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	23 ## function is meant to be run for generating octave documentation
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	24 ## (see doc/interpreter/graphics_properties.mk).
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	25 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	26 ## All the hard coded documentation is written in getdoc function. See the
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	27 ## comments in getdoc bellow for instruction on how to document a graphics
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	28 ## property.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	29 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	30 ## @seealso{}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	31 ## @end deftypefn
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	32
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	33 function genpropdoc (objname, fname)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	34 objnames = {"root", "figure", "axes", "line", ...
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	35 "text", "image", "patch", "surface", "light", ...
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	36 "uimenu", "uibuttongroup", "uicontextmenu", "uipanel", ...
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	37 "uicontrol", "uitoolbar", "uipushtool", "uitoggletool"};
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	38
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	39 ## Base properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	40 base = getstructure ("base");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	41
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	42 ## Object properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	43 if (any (strcmp (objname, objnames)))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	44 obj = getstructure (objname, base);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	45 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	46 error ("genpropdoc: unknown object %s", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	47 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	48
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	49 ## Docstring
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	50 str = printdoc (objname, obj);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	51
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	52 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	53 fid = fopen (fname, "w+");
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	54 if (fid < 0)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	55 error ("genpropdoc: couldn't open %s.", fname);
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	56 endif
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	57 else
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	58 fid = stdout;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	59 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	60
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	61 fprintf (fid, str);
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	62
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	63 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	64 fclose (fid);
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	65 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	66
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	67 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	68
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	69 function s = getdoc (objname, field, base)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	70 ## Properties are represented by a struct with fields :
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	71 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	72 ## -"doc": string to be printed verbatim after being expanded
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	73 ## through expand_doc function. Special keywords are:
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	74 ## "__objname__" : replaced by the current object name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	75 ## "__prop__" : replaced by the current property name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	76 ## "__modemsg__" : replaced by a message explaining that
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	77 ## the propmode will be toggled to "manual".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	78 ## You may also cross reference properties using the label format
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	79 ## OBJNAMEPROPERTY, e.g, "@xref{XREFaxescolor, , axes color property}."
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	80 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	81 ## -"valid": string that describes valid values for the current property.
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	82 ## Use "packopt" function to join options with " \| " separator
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	83 ## and "markdef" to mark default among valid values between curly braces.
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	84 ## If not provided, valid values for radio properties are automatically
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	85 ## retrieved using set function.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	86 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	87 ## -"default": string. If not provided the default value is automatically
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	88 ## retrieved using get function.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	89 ##
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	90 ## -"printdefault": a boolean (def. true) that specifies whether the
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	91 ## default value should be printed. It is useful for properties
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	92 ## like root "screendepth" that default to screen dependant values.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	93
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	94 packopt = @(c) strjoin (c, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	95 markdef = @(s) ["@{" s "@}"];
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	96
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	97 ## Some generic templates:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	98 valid_color = "colorspec";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	99 valid_handle = "graphics handle";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	100 valid_string = "string";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	101 valid_fcn = packopt ({"string", "function handle"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	102 valid_cellstring = packopt ({"string", "cell array of strings"});
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	103 valid_2elvec = "two-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	104 valid_3elvec = "three-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	105 valid_4elvec = "four-element vector";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	106 valid_vecmat = packopt ({"vector", "matrix"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	107 valid_scalmat = packopt ({"scalar", "matrix"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	108
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	109 doc_notimpl = "%s is not yet implemented for __objname__ objects. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	110 __prop__ is unused.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	111 doc_unused = "__prop__ is unused.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	112
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	113 doc_fontangle = "Control whether the font is italic or normal.";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	114 doc_fontsize = "Size of the font used for text rendering. \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	115 @xref{XREF__objname__fontunits, , fontunits property}.";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	116 doc_fontname = "Name of font used for text rendering. When setting \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	117 this property, the text rendering engine will search for a matching \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	118 font in your system. If none is found then text is rendered using a \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	119 default sans serif font (same as the default @qcode{\"*\"} value).";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	120 doc_fontunits = "Units used to interpret the @qcode{\"fontsize\"} property.";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	121 doc_fontweight = "Control the variant of the base font used for \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	122 text rendering.";
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	123
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	124 ## Initialize structure
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	125 if (isfield (base, field))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	126 s = base.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	127 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	128 s = struct ("valid", "", "default", "", "doc", "", "printdefault", true);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	129 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	130
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	131 ## Base properties: Write generic documentation because it will be included
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	132 ## in the list of each graphics object. If a given graphics object
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	133 ## interprets the property differently than others, then the doc will have
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	134 ## to be rewritten for this object.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	135 if (strcmp (objname, "base"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	136 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	137 case "beingdeleted"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	138 case "busyaction"
24626 58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	139 s.doc = "Define how Octave handles the execution of this object's \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	140 callback properties when it is unable to interrupt another object's \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	141 executing callback. This is only relevant when the currently executing \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	142 callback object has its @code{interruptible} property set to \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	143 \@qcode{\"off\"}. The __prop__ property of the interrupting callback object \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	144 indicates whether the interrupting callback is queued (@qcode{\"queue\"} \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	145 (default)) or discarded (@qcode{\"cancel\"}).\n\
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	146 @xref{Callbacks, , @w{Callbacks section}}.";
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	147
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	148 case "buttondownfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	149 s.doc = "__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	150 s.valid = valid_fcn;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	151
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	152 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	153 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	154 s.valid = "vector of graphics handles";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	155
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	156 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	157 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	158 clipped in its parent axes limits.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	159
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	160 case "createfcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	161 s.doc = "Callback function executed immediately after __objname__ \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	162 has been created. Function is set by using default property on root object, \
24462 8ff3c13d14c1 groot.m: New function to return handle of graphics root object. Rik <rik@octave.org> parents: 24423 diff changeset	163 e.g., @code{set (groot, \"default__objname__createfcn\", \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	164 'disp (\"__objname__ created!\")')}.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	165 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	166
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	167 case "deletefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	168 s.doc = "Callback function executed immediately before __objname__ \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	169 is deleted.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	170 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	171
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	172 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	173 s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__'s \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	174 handle is not visible in its parent's \"children\" property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	175
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	176 case "hittest"
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	177 s.doc = "Specify whether __objname__ processes mouse events \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	178 or passes them to ancestors of the object. When enabled, the object may \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	179 respond to mouse clicks by evaluating the @qcode{\"buttondownfcn\"}, showing \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	180 the uicontextmenu, and eventually becoming the root \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	181 @qcode{\"currentobject\"}. This property is only relevant when the object \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	182 can accept mouse clicks which is determined by the @qcode{\"pickableparts\"} \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	183 property. @xref{XREF__objname__pickableparts, , @w{pickableparts property}}.";
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	184
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	185 case "interruptible"
24626 58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	186 s.doc = "Specify whether this object's callback functions may be \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	187 interrupted by other callbacks. By default __prop__ is @qcode{\"on\"} \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	188 and callbacks that make use of @code{drawnow}, @code{figure}, @code{waitfor}, \
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	189 @code{getframe} or @code{pause} functions are eventually interrupted.\n\
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	190 @xref{Callbacks, , @w{Callbacks section}}.";
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	191
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	192 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	193 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	194 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	195
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	196 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	197 s.doc = "Specify whether __objname__ will accept mouse clicks. \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	198 By default, __prop__ is @qcode{\"visible\"} and only visible parts of the \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	199 __objname__ or its children may react to mouse clicks. When __prop__ is \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	200 @qcode{\"all\"} both visible and invisible parts (or children) may react to \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	201 mouse clicks. When __prop__ is @qcode{\"none\"} mouse clicks on the object \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	202 are ignored and transmitted to any objects underneath this one. When an \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	203 object is configured to accept mouse clicks the @qcode{\"hittest\"} property \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	204 will determine how they are processed. \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	205 @xref{XREF__objname__hittest, , @w{hittest property}}.";
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	206
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	207 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	208 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	209 case "tag"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	210 s.doc = "A user-defined string to label the graphics object.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	211 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	212
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	213 case "type"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	214 s.doc = "Class name of the graphics object. __prop__ is \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	215 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	216 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	217 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	218
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	219 case "uicontextmenu"
20077 69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	220 s.doc = "Graphics handle of the uicontextmenu object that is \
69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	221 currently associated to this __objname__ object.";
69f92e0affd2 Handle uicontextmenu deletion/reset (bug #44801) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19834 diff changeset	222 s.valid = valid_handle;
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	223
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	224 case "userdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	225 s.doc = "User-defined data to associate with the graphics object.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	226 s.valid = "Any Octave data";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	227
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	228 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	229 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	230 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	231 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	232
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	233 ## Root properties:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	234 elseif (strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	235 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	236 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	237 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	238 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	239 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	240 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	241 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	242
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	243 case "parent"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	244 s.doc = "Root figure has no parent graphics object. __prop__ \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	245 is always empty.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	246
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	247 case "hittest"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	248 s.doc = doc_unused;
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	249
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	250 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	251 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	252
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	253 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	254 case "callbackobject"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	255 s.doc = "Graphics handle of the current object whose callback is executing.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	256 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	257
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	258 case "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	259 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	260 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	261
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	262 case "diary"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	263 s.doc = "If __prop__ is @qcode{\"on\"}, the Octave command window \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	264 session is saved to file. @xref{XREFrootdiaryfile, , @w{diaryfile property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	265
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	266 case "diaryfile"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	267 s.doc = "The name of the diary file. \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	268 @xref{XREFdiary, , @w{diary function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	269 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	270
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	271 case "echo"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	272 s.doc = "Control whether Octave displays commands executed from \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	273 scripts. @xref{XREFecho, , @w{echo function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	274
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	275 case "errormessage"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	276 s.doc = "The last error message raised. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	277 @xref{XREFlasterr, , @w{lasterr function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	278 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	279
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	280 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	281 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	282
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	283 case "format"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	284 s.doc = "This property is a wrapper around the @code{format} function.\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	285 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	286
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	287 case "formatspacing"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	288 s.doc = "This property is a wrapper around the @code{format} function.\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	289 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	290
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	291 case "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	292 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	293
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	294 case "monitorpositions"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	295 s.doc = doc_unused;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	296 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	297
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	298 case "pointerlocation"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	299 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	300 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	301
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	302 case "pointerwindow"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	303 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	304 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	305
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	306 case "recursionlimit"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	307 s.doc = "The maximum number of times a function can be called \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	308 recursively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	309 @xref{XREFmax_recursion_depth, , @w{max_recursion_depth function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	310 s.valid = "double";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	311
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	312 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	313 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	314 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	315
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	316 case "screenpixelsperinch"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	317 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	318 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	319
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	320 case "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	321 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	322 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	323
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	324 case "showhiddenhandles"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	325 s.doc = "If __prop__ is @qcode{\"on\"}, all graphics objects handles \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	326 are visible in their parents' children list, regardless of the value of their \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	327 @code{handlevisibility} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	328
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	329 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	330 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	331
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	332 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	333 elseif (strcmp (objname, "figure"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	334 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	335 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	336 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	337 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	338
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	339 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	340 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	341
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	342 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	343 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	344 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	345
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	346 case "closerequestfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	347 s.doc = "Function that is executed when a figure is deleted. \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	348 @xref{XREFclosereq, , closereq function}.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	349 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	350
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	351 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	352 s.doc = "Color of the figure background. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	353 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	354 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	355
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	356 case "colormap"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	357 s.doc = "A matrix containing the RGB color map for the current axes.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	358 s.valid = "N-by-3 matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	359
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	360 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	361 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	362 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	363
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	364 case "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	365 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	366
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	367 case "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	368 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	369
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	370 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	371 s.doc = "A 1-by-2 matrix which holds the coordinates of the point \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	372 over which the mouse pointer was when a mouse event occurred. The X and Y \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	373 coordinates are in units defined by the figure's @code{units} property \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	374 and their origin is the lower left corner of the plotting area.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	375 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	376 Events which set @code{currentpoint} are\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	377 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	378 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	379 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	380 @item A mouse button was released\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	381 only if the figure's callback @code{windowbuttonupfcn} is defined\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	382 @item The pointer was moved while pressing the mouse button (drag)\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	383 only if the figure's callback @code{windowbuttonmotionfcn} is defined\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	384 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	385 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	386
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	387 case "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	388 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	389
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	390 case "filename"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	391 s.doc = "The filename used when saving the plot figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	392 s.valid = valid_string;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	393
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	394 case "graphicssmoothing"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	395 s.doc = "Use smoothing techniques to reduce the appearance of jagged lines.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	396
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	397 case "integerhandle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	398 s.doc = "Assign the next lowest unused integer as the Figure number.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	399
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	400 case "inverthardcopy"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	401 s.doc = "Replace the figure and axes background color with white when printing.";
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	402
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	403 case "keypressfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	404 s.doc = "Callback function executed when a keystroke event \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	405 happens while the figure has focus. The actual key that was pressed \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	406 can be retrieved using the second argument 'evt' of the function. __fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	407 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	408
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	409 case "keyreleasefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	410 s.doc = "With @code{keypressfcn}, the keyboard callback functions. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	411 These callback functions are called when a key is pressed/released \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	412 respectively. The functions are called with two input arguments. The first \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	413 argument holds the handle of the calling figure. The second argument holds \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	414 an event structure which has the following members:\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	415 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	416 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	417 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	418 @item Key:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	419 Lowercase value of the key\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	420 @item Modifier:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	421 A cell array containing strings representing the modifiers pressed with the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	422 key.\n\
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	423 @end table\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	424 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	425 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	426
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	427 case "menubar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	428 s.doc = "Control the display of the figure menu bar at the top \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	429 of the figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	430
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	431 case "name"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	432 s.doc = "Name to be displayed in the figure title bar. The name is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	433 displayed to the right of any title determined by the @code{numbertitle} \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	434 property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	435 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	436
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	437 ## FIXME: Uncomment when support added in graphics.in.h
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	438 #case "number"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	439 # s.doc = "Number of current figure (RO).";
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	440
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	441 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	442 s.doc = "__prop__ is used by high level plotting functions to \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	443 decide what to do with axes already present in the figure. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	444 @xref{XREFnewplot, , @w{newplot function}}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	445
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	446 case "numbertitle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	447 s.doc = "Display \"Figure\" followed by the numerical figure handle \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	448 value in the figure title bar.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	449
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	450 case "outerposition"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	451 s.doc = "Specify the position and size of the figure including \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	452 the top menubar and the bottom status bar. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	453 The four elements of the vector are the coordinates of the lower left corner \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	454 and width and height of the figure. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	455 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	456 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	457
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	458 case "paperorientation"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	459 s.doc = "The value for the @code{papersize}, and @code{paperposition} \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	460 properties depends upon __prop__. The horizontal and vertical values for \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	461 @code{papersize} and @code{paperposition} reverse order \
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	462 when __prop__ is switched between @code{\"portrait\"} and \
22506 84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation Rik <rik@octave.org> parents: 22323 diff changeset	463 @code{\"landscape\"}.";
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	464
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	465 case "paperposition"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	466 s.doc = "Vector @code{[left bottom width height]} defining the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	467 position and size of the figure (in @code{paperunits} units) on the printed \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	468 page. The position @code{[left bottom]} defines the lower left corner of the \
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	469 figure on the page, and the size is defined by @code{[width height]}. For \
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	470 output formats not implicitly rendered on paper, @code{width} and \
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	471 @code{height} define the size of the image and the position information is \
241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	472 ignored. \
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	473 __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	474 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	475
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	476 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	477 s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	478 @code{paperposition} property is automatically computed: the printed \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	479 figure will have the same size as the on-screen figure and will be centered \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	480 on the output page. Setting the __prop__ to @code{\"auto\"} does not modify \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	481 the value of the @code{paperposition} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	482
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	483 case "papersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	484 s.doc = "Vector @code{[width height]} defining the size of the \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	485 paper for printing. Setting the __prop__ property to a value, not associated \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	486 with one of the defined @code{papertypes} and consistent with the setting for \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	487 @code{paperorientation}, forces the @code{papertype} property to the value \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	488 @qcode{\"<custom>\"}. If __prop__ is set to a value associated with a \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	489 supported @code{papertype} and consistent with the @code{paperorientation}, \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	490 the @code{papertype} value is modified to the associated value.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	491 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	492
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	493 case "papertype"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	494 s.doc = "Name of the paper used for printed output. \
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	495 Setting __prop__ also changes @code{papersize}, while maintaining consistency \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	496 with the @code{paperorientation} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	497
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	498 case "paperunits"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	499 s.doc = "The unit used to compute the @code{paperposition} property. \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	500 For __prop__ set to @code{\"pixels\"}, the conversion between physical \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	501 units (ex: @code{\"inches\"}) and @code{\"pixels\"} is dependent on the \
3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	502 @code{screenpixelsperinch} property of the root object.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	503
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	504 case "pointer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	505 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	506 case "pointershapecdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	507 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	508 case "pointershapehotspot"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	509 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	510
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	511 case "position"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	512 s.doc = "Specify the position and size of the figure canvas. \
22507 5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	513 The four elements of the vector are the coordinates of the lower left corner \
5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	514 and width and height of the figure. \
5017f4ee1348 genpropdoc.m: Add explanation for figure "position" property (bug #49104). Tatsuro Matsuoka <tmacchant@yahoo.co.jp> parents: 22506 diff changeset	515 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	516 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	517
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	518 case "renderer"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	519 s.doc = doc_unused;
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	520
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	521 case "renderermode"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	522 s.doc = doc_unused;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	523
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	524 case "resize"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	525 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	526
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	527 case "resizefcn"
22506 84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation Rik <rik@octave.org> parents: 22323 diff changeset	528 s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	529 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	530
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	531 case "selectiontype"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	532 ## FIXME: docstring explaining what "{normal}\|open\|alt\|extend" mean.
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	533
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	534 case "sizechangedfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	535 s.doc = "Callback triggered when the figure window size is changed.\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	536 \n\n__fcnmsg__";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	537 s.valid = valid_fcn;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	538
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	539 case "toolbar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	540 s.doc = "Control the display of the toolbar (along the bottom of the \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	541 menubar) and the status bar. When set to @qcode{\"auto\"}, the display is based on the value of the @code{menubar} property.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	542
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	543 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	544 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	545 @code{outerposition} properties.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	546
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	547 case "windowbuttondownfcn"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	548 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	549 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	550 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	551
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	552 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	553 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	554 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	555 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	556
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	557 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	558 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	559 @code{windowbuttonmotionfcn}, the mouse callback functions. These \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	560 callback functions are called when a mouse button is pressed, dragged, or \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	561 released respectively. When these callback functions are executed, the \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	562 @code{currentpoint} property holds the current coordinates of the cursor.\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	563 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	564 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	565
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	566 case "windowkeypressfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	567 s.doc = "Function that is executed when a key is pressed and \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	568 the figure has focus.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	569 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	570
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	571 case "windowkeyreleasefcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	572 s.doc = "Function that is executed when a key is released and \
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	573 the figure has focus.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	574 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	575
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	576 case "windowscrollwheelfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	577 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	578 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	579
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	580 case "windowstyle"
21996 d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	581 s.doc = "The window style of a figure. One of the following values:\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	582 @table @code\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	583 @item normal\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	584 Set the window style as non modal.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	585 @item modal\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	586 Set the window as modal so that it will stay on top of all normal figures.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	587 @item docked\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	588 Setting the window style as docked currently does not dock the window.\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	589 @end table\n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	590 \n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	591 Changing modes of a visible figure may cause the figure to close and reopen.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	592
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	593 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	594
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	595 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	596 elseif (strcmp (objname, "axes"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	597 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	598 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	599 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	600 s.doc = doc_unused;
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 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	603 case "activepositionproperty"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	604 s.doc = "Specify which of @qcode{\"position\"} or \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	605 @qcode{\"outerposition\"} properties takes precedence when axes \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	606 annotations extent changes. @xref{XREFaxesposition, , @w{position property}}, \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	607 and @ref{XREFaxesposition, , @w{outerposition property}}.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	608
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	609 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	610 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	611
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	612 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	613 case "ambientlightcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	614 s.doc = doc_unused;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	615
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	616 case "box"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	617 s.doc = "Control whether the axes has a surrounding box.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	618
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	619 case "boxstyle"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	620 s.doc = "For 3-D axes, control whether the @qcode{\"full\"} \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	621 box is drawn or only the 3 @qcode{\"back\"} axes";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	622
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	623 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	624 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	625
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	626 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	627 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	628 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	629
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	630 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	631 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	632 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	633
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	634 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	635 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	636 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	637
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	638 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	639 case "clim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	640 s.doc = "Define the limits for the color axis of image children. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	641 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	642 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	643
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	644 case "climmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	645
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	646 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	647 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	648
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	649 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	650 s.doc = "Color of the axes background. @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	651 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	652
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	653 case "colororder"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	654 s.doc = "RGB values used by plot function for automatic line \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	655 coloring.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	656 s.valid = "N-by-3 RGB matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	657
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	658 case "colororderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	659 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	660
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	661 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	662 s.doc = "Matrix @code{[xf, yf, zf; xb, yb, zb]} which holds the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	663 coordinates (in axes data units) of the point over which the mouse pointer \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	664 was when the mouse button was pressed. If a mouse callback function is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	665 defined, @code{currentpoint} holds the pointer coordinates at the time \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	666 the mouse button was pressed. For 3-D plots, the first row of the returned \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	667 matrix specifies the point nearest to the current camera position and the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	668 second row the furthest point. The two points forms a line which is \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	669 perpendicular to the screen.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	670 s.valid = "2-by-3 matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	671
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	672 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	673 s.doc = "Specify the relative height and width of the data \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	674 displayed in the axes. Setting @code{dataaspectratio} to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	675 @w{@code{[1, 2]}} causes the length of one unit as displayed on the x-axis \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	676 to be the same as the length of 2 units on the y-axis. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	677 @xref{XREFdaspect, , daspect function}. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	678 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	679
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	680 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	681 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	682 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	683
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	684 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	685 s.doc = doc_fontname;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	686 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	687
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	688 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	689 s.doc = doc_fontsize;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	690 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	691
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	692 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	693 s.doc = doc_fontunits;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	694
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	695 case "fontsmoothing"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	696 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	697
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	698 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	699 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	700
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	701 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	702 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	703
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	704 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	705 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	706
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	707 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	708 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	709
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	710 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	711 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	712
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	713 case "gridlinestyle"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	714
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	715 case "labelfontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	716 s.doc = "Ratio between the x/y/zlabel fontsize and the tick \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	717 label fontsize";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	718
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	719 case "layer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	720 s.doc = "Control whether the axes is drawn below child graphics \
21530 7c143e73e921 doc: Don't create end-of-sentence period with "etc." in Texinfo. Rik <rik@octave.org> parents: 21319 diff changeset	721 objects (ticks, labels, etc.@: covered by plotted objects) or above.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	722
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	723 case "linestyleorder"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	724 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	725
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	726 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	727 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	728
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	729 case "linewidth"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	730 s.doc = "Width of the main axes lines";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	731
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	732 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	733 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	734
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	735 case "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	736 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	737
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	738 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	739 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	740
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	741 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	742 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	743
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	744 case "minorgridlinestyle"
19776 4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom". Rik <rik@octave.org> parents: 19746 diff changeset	745 case "mousewheelzoom"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	746 s.doc = "Fraction of axes limits to zoom for each wheel movement.";
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	747 s.valid = "scalar in the range (0, 1)";
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	748
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	749 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	750 s.doc = "__prop__ is used by high level plotting functions to \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	751 decide what to do with graphics objects already present in the axes. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	752 @xref{XREFnewplot, , @w{newplot function}}. The state of __prop__ \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	753 is typically controlled using the @code{hold} function. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	754 @xref{XREFhold, , @w{hold function}}.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	755
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	756 case "outerposition"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	757 s.doc = "Specify the position of the plot including titles, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	758 axes, and legend. The four elements of the vector are the \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	759 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	760 plot, in units normalized to the width and height of the plot \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	761 window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	762 left corner of the axes at @math{(0.2, 0.3)} and the width and \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	763 height to be 0.4 and 0.5 respectively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	764 @xref{XREFaxesposition, , @w{position property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	765 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	766
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	767 case "plotboxaspectratio"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	768 s.doc = "@xref{XREFpbaspect, , pbaspect function}. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	769 __modemsg__.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	770
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	771 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	772 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	773 s.doc = "Specify the position of the plot excluding titles, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	774 axes, and legend. The four elements of the vector are the \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	775 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	776 plot, in units normalized to the width and height of the plot \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	777 window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	778 left corner of the axes at @math{(0.2, 0.3)} and the width and \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	779 height to be 0.4 and 0.5 respectively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	780 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	781 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	782
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	783 case "projection"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	784 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	785
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	786 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	787 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	788
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	789 case "tickdir"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	790 s.doc = "Control whether axes tick marks project \"in\" to the plot \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	791 box or \"out\". __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	792
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	793 case "tickdirmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	794
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	795 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	796 s.doc = "Control the way x/y/zticklabel properties are interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	797 @xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	798
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	799 case "ticklength"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	800 s.doc = "Two-element vector @code{[2Dlen 3Dlen]} specifying the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	801 length of the tickmarks relative to the longest visible axis.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	802 s.valid = valid_2elvec;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	803
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	804 case "tightinset"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	805 s.doc = "Size of the @code{[left bottom right top]} margins \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	806 around the axes that enclose labels and title annotations.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	807 s.valid = valid_4elvec;
25783 e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	808 s.printdefault = false;
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	809
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	810 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	811 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	812 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	813
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	814 case "titlefontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	815 s.doc = "Ratio between the title fontsize and the tick \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	816 label fontsize";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	817 s.valid = "positive scalar";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	818
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	819 case "titlefontweight"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	820 s.doc = "Control variant of base font used for the axes title.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	821
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	822 case "units"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	823 s.doc = "Units used to interpret the @qcode{\"position\"}, \
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	824 @qcode{\"outerposition\"}, and @qcode{\"tightinset\"} properties.";
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	825
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	826 case "view"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	827 s.doc = "Two-element vector @code{[azimuth elevation]} specifying \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	828 the viewpoint for three-dimensional plots";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	829 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	830
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	831 case "xaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	832 s.doc = "Control the x axis location.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	833
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	834 case "xcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	835 s.doc = "Color of the x-axis. @xref{Colors, , colorspec}. \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	836 __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	837 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	838
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	839 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	840
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	841 case "xdir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	842 s.doc = "Direction of the x axis: @qcode{\"normal\"} is left \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	843 to right.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	844
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	845 case "xgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	846 s.doc = "Control whether major x grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	847
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	848 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	849 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	850 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	851
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	852 case "xlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	853 s.doc = "Two-element vector @code{[xmin xmax]} specifying the limits \
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	854 for the x-axis. __modemsg__. @xref{XREFxlim, , @w{xlim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	855 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	856
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	857 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	858 case "xminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	859 s.doc = "Control whether minor x grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	860
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	861 case "xminortick"
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	862 case "xscale"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	863 case "xtick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	864 s.doc = "Position of x tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	865 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	866 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	867
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	868 case "xticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	869 s.doc = "Labels of x tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	870 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	871
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	872 case "xticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	873 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	874 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	875
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	876 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	877 case "yaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	878 s.doc = "Control the y-axis location.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	879
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	880 case "ycolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	881 s.doc = "Color of the y-axis. @xref{Colors, , colorspec}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	882 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	883
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	884 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	885
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	886 case "ydir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	887 s.doc = "Direction of the y-axis: @qcode{\"normal\"} is bottom \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	888 to top.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	889
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	890 case "ygrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	891 s.doc = "Control whether major y grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	892
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	893 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	894 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	895 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	896
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	897 case "ylim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	898 s.doc = "Two-element vector @code{[ymin ymax]} specifying the limits \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	899 for the y-axis. __modemsg__. @xref{XREFylim, , @w{ylim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	900 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	901
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	902 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	903 case "yminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	904 s.doc = "Control whether minor y grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	905
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	906 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	907 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	908 case "ytick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	909 s.doc = "Position of y tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	910 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	911 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	912
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	913 case "yticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	914 s.doc = "Labels of y tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	915 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	916
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	917 case "yticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	918 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	919 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	920
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	921 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	922 case "zcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	923 s.doc = "Color of the z-axis. @xref{Colors, , colorspec}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	924 s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	925
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	926 case "zcolormode"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	927 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	928 case "zgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	929 s.doc = "Control whether major z grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	930
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	931 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	932 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	933 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	934
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	935 case "zlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	936 s.doc = "Two-element vector @code{[zmin zmaz]} specifying the limits \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	937 for the z-axis. __modemsg__. @xref{XREFzlim, , @w{zlim function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	938 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	939
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	940 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	941 case "zminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	942 s.doc = "Control whether minor z grid lines are displayed.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	943
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	944 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	945 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	946 case "ztick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	947 s.doc = "Position of z tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	948 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	949 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	950
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	951 case "zticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	952 s.doc = "Labels of z tick marks. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	953 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	954
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	955 case "zticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	956 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	957 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	958
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	959 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	960 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	961
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	962 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	963 elseif (strcmp (objname, "line"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	964 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	965 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	966 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	967 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	968
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	970 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	971 s.doc = "Color of the line object. @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	972 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	973
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	974 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	975 s.doc = "Text for the legend entry corresponding to this line.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	976 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	977
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	978 case "interpreter"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	979
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	980 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	981 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	982
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	983 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	984 s.doc = "Width of the line object measured in points.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	985
22759 39f39eb4e476 Implement "linejoin" property (bug #48387) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22755 diff changeset	986 case "linejoin"
39f39eb4e476 Implement "linejoin" property (bug #48387) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22755 diff changeset	987 s.doc = "Control the shape of the junction of line segments. \
39f39eb4e476 Implement "linejoin" property (bug #48387) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22755 diff changeset	988 This property currently only affects the printed output.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	989
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	990 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	991 s.doc = "Shape of the marker for each data point. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	992 @xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	993
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	994 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	995 s.doc = "Color of the edge of the markers. When set to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	996 @qcode{\"auto\"}, the marker edges have the same color as the line. If set \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	997 to @qcode{\"none\"}, no marker edges are displayed. This property can also \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	998 be set to any color. @xref{Colors, , colorspec}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	999
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1000 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1001 s.doc = "Color of the face of the markers. When set to \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1002 @qcode{\"auto\"}, the marker faces have the same color as the line. If set \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1003 to @qcode{\"none\"}, the marker faces are not displayed. This property \
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1004 can also be set to any color. @xref{Colors, , colorspec}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1005
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1006 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1007 s.doc = "Size of the markers measured in points.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1008 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1009
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1010 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1011 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	1012 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1013
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1014 case "xdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1015 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1016 x data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1017 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1018
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1019 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1020 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	1021 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1022
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1023 case "ydatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1024 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1025 y data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1026 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1027
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1028 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1029 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	1030 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1031
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1032 case "zdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1033 s.doc = "Name of a vector in the current base workspace to use as \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1034 z data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1035 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1036
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1037 endswitch
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 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1040 elseif (strcmp (objname, "text"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1041 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1042 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1043 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1044 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1045
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1046 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1047 case "backgroundcolor"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1048 s.doc = "Color of the background area. \
730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1049 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1050 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1051
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1052 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1053 s.doc = "Color of the text. @xref{Colors, ,colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1054 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1055
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1056 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1057 case "edgecolor"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1058 s.doc = "Color of the outline of the background area. \
730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1059 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1060 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1061
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1062 case "editing"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1063 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1064
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1065 case "extent"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1066 s.doc = "Vector @code{[x0 y0 width height]} indicating the size \
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1067 and location of the text string.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1068 s.valid = valid_4elvec;
25783 e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1069 s.printdefault = false;
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	1070
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1071 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1072 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1073
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1074 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1075 s.doc = doc_fontname;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1076 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1077
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1078 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1079 s.doc = doc_fontsize;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1080 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1081
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1082 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1083 s.doc = doc_fontunits;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1084
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1085 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1086 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1087
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1088 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1089 case "interpreter"
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1090 s.doc = "Control the way the @qcode{\"string\"} property is \
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1091 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1092 @xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1093
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1094 case "linestyle"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1095 s.doc = "Style of the outline. @xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1096
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1097 case "linewidth"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1098 s.doc = "Width of the outline.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1099 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1100
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1101 case "margin"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1102 s.doc = "Margins between the borders of the background area \
730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1103 and the texts. The value is currently interpreted as pixels, regardless \
730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1104 of the @qcode{\"fontunits\"} property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1105 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1106
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1107 case "position"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1108 s.doc = "Vector @code{[X0 Y0 Z0]} where X0, Y0 and Z0 indicate the \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1109 position of the text anchor as defined by @code{verticalalignment} and \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1110 @code{horizontalalignment}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1111 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1112
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1113 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1114 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	1115 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1116 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1117
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1118 case "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1119 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1120 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1121
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1122 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1123 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1124 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1125
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1126 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1127 elseif (strcmp (objname, "image"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1128 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1129 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1130 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1131 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1132
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1133 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1134 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1135 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1136 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1137
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1138 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1139 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1140
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1141 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1143
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1144 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1145 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1146 s.doc = "Text for the legend entry corresponding to this image.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1147 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1148
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1149 case "xdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1150 s.doc = "Two-element vector @code{[xmin xmax]} specifying the x \
25856 9578af67a0d4 Document that image x/ydata indicate the centers of corner pixels (bug #54610). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25783 diff changeset	1151 coordinates of the centers of the first and last columns of the image.\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1152 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1153 Setting @code{xdata} to the empty matrix ([]) will restore the default value \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1154 of @code{[1 columns(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1155 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1156
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1157 case "ydata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1158 s.doc = "Two-element vector @code{[ymin ymax]} specifying the y \
25856 9578af67a0d4 Document that image x/ydata indicate the centers of corner pixels (bug #54610). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25783 diff changeset	1159 coordinates of the centers of the first and last rows of the image.\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1160 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1161 Setting @code{ydata} to the empty matrix ([]) will restore the default value \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1162 of @code{[1 rows(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1163 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1164
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1165 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1166
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1167 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1168 elseif (strcmp (objname, "surface"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1169 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1170 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1171 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1172 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1173
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1174 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1175 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1176 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1177 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1178
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1179 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1180 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1181
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1182 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1183 s.doc = "Strength of the ambient light. Value between 0.0 and 1.0";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1184 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1185
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1186 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1187 s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1188 @qcode{\"reverselit\"}: The normals are always oriented towards the point of view. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1189 @qcode{\"unlit\"}: Faces with normals pointing away from the point of view are unlit.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1190
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1191 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1193
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1194 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1195 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1196 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1197 s.doc = "Strength of the diffuse reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1198 diffuse reflex) and 1.0 (full diffuse reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1199 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1200
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1201 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1202 s.doc = "Text for the legend entry corresponding to this surface.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1203
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1204 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1205 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1206 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1207
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1208 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1209 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1210 s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1211 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1212 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1213 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1214 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1215 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1216
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1217 case "facealpha"
24154 78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1218 s.doc = "Transparency level of the faces of the surface object. Only \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1219 double values are supported at present where a value of 0 means complete \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1220 transparency and a value of 1 means solid faces without transparency. Setting \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1221 the property to @qcode{\"flat\"}, @qcode{\"interp\"} or @qcode{\"texturemap\"} \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1222 causes the faces to not being rendered. Additionally, the faces are not sorted \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1223 from back to front which might lead to unexpected results when rendering \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1224 layered transparent faces.";
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1225 s.valid = packopt ({"scalar", ...
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1226 "@qcode{\"flat\"}", ...
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1227 "@qcode{\"interp\"}", ...
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1228 "@qcode{\"texturemap\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1229
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1230 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1231 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1232 s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1233 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1234 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1235 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1236 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1237 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1238
25867 49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1239 case "facenormals"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1240 s.doc = "Face normals are used for lighting the edges or faces if the \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1241 @code{edgelighting} or @code{facelighting} properties are set to \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1242 @qcode{\"flat\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1243
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1244 case "facenormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1245 s.doc = "If this property is set to @qcode{\"auto\"}, \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1246 @code{facenormals} are automatically calculated if the @code{edgelighting} or \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1247 @code{facelighting} property are set to @qcode{\"flat\"} and at least one \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1248 @code{light} object is present and visible in the same axes.";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1249
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1250 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1251 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1252 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1253
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1254 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1255 s.doc = "@xref{XREFlinelinewidth, , @w{line linewidth property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1256
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1257 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1258 s.doc = "@xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1259
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1260 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1261 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1262 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1263
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1264 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1265 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1266 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1267
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1268 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1269 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1270 @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1271 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1272
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1273 case "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1274 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1275 s.doc = "Reflectance for specular color. Value between 0.0 (color \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1276 of underlying face) and 1.0 (color of light source).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1277 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1278
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1279 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1280 s.doc = "Exponent for the specular reflex. The lower the value, \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1281 the more the reflex is spread out.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1282 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1283
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1284 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1285 s.doc = "Strength of the specular reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1286 specular reflex) and 1.0 (full specular reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1287 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1288
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1289 case "vertexnormals"
25867 49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1290 s.doc = "Vertex normals are used for lighting the edges or faces if \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1291 the @code{edgelighting} or @code{facelighting} properties are set to \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1292 @qcode{\"gouraud\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1293
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1294 case "vertexnormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1295 s.doc = "If this property is set to @qcode{\"auto\"}, \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1296 @code{vertexnormals} are automatically calculated if the @code{edgelighting} \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1297 or @code{facelighting} property are set to @qcode{\"gouraud\"} and at least \
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1298 one @code{light} object is present and visible in the same axes.";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1299
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1300 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1301 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1302
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1303 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1304 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1305 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1306
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1307 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1308 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1309 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1310
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1311 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1312 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1313
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1314 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1315 elseif (strcmp (objname, "patch"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1316 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1317 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1318 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1319 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1320
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1321 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1322 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1323 s.doc = sprintf (doc_notimpl, "Transparency");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1324
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1325 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1326 s.doc = "Strength of the ambient light. Value between 0.0 and 1.0";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1327 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1328
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1329 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1330 s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1331 @qcode{\"reverselit\"}: The normals are always oriented towards the point of view. \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1332 @qcode{\"unlit\"}: Faces with normals pointing away from the point of view are unlit.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1333
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1334 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1335 s.doc = "Data defining the patch object color.\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1336 Patch color can be defined for faces or for vertices.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1337 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1338 If @code{cdata} is a scalar index into the current colormap or a RGB triplet, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1339 it defines the color of all faces.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1340 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1341 If @code{cdata} is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1342 it defines the color of each one of the N faces.\n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1343 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1344 If @code{cdata} is an N-by-M or an N-by-M-by-3 (RGB) matrix, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1345 it defines the color at each vertex.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1346 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1347
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1348 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1349 s.doc = "Strength of the diffuse reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1350 diffuse reflex) and 1.0 (full diffuse reflex).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1351 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1352
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1353 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1354 s.doc = "Text of the legend entry corresponding to this patch.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1355
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1356 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1357 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1358 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1359
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1360 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1361 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1362 s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1363 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1364 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1365 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1366 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1367 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1368
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1369 case "facealpha"
24154 78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1370 s.doc = "Transparency level of the faces of the patch object. Only \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1371 double values are supported at present where a value of 0 means complete \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1372 transparency and a value of 1 means solid faces without transparency. Setting \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1373 the property to @qcode{\"flat\"} or @qcode{\"interp\"} causes the faces to not \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1374 being rendered. Additionally, the faces are not sorted from back to front \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1375 which might lead to unexpected results when rendering layered transparent \
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1376 faces.";
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1377 s.valid = packopt ({"scalar", ...
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1378 "@qcode{\"flat\"}", ...
78ff6ba5cbb1 Add basic support of "facealpha" for surfaces and patches in OpenGL (bug #39535) Markus Mützel <markus.muetzel@gmx.de> parents: 23396 diff changeset	1379 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1380
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1381 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1382 ## 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	1383 ## 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	1384 s.valid = packopt ({markdef(valid_color), ...
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1385 "@qcode{\"none\"}", ...
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1386 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1387 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1388
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1389 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1390 s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1391 of the object are drawn with light and shadow effects. Supported values are \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1392 @qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (facetted look) and \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1393 @qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1394 the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1395 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1396
25605 beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1397 case "facenormals"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1398 s.doc = "Face normals are used for lighting the edges or faces if the \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1399 @code{edgelighting} or @code{facelighting} properties are set to \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1400 @qcode{\"flat\"}. __modemsg__";
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1401
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1402 case "facenormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1403 s.doc = "If this property is set to @qcode{\"auto\"}, \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1404 @code{facenormals} are automatically calculated if the @code{edgelighting} or \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1405 @code{facelighting} property are set to @qcode{\"flat\"} and at least one \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1406 @code{light} object is present and visible in the same axes.";
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1407
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1408 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1409 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1410
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1411 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1412 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1413 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1414
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1415 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1416 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1417 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1418
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1419 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1420 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1421 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1422 s.doc = "@xref{XREFlinemarker, , @w{line marker property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1423
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1424 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1425 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1426 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1427
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1428 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1429 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1430 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1431
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1432 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1433 s.doc = "@xref{XREFlinemarkersize, , @w{line markersize property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1434 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1435
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1436 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1437 s.doc = "Reflectance for specular color. Value between 0.0 (color \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1438 of underlying face) and 1.0 (color of light source).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1439 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1440
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1441 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1442 s.doc = "Exponent for the specular reflex. The lower the value, \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1443 the more the reflex is spread out.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1444 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1445
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1446 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1447 s.doc = "Strength of the specular reflex. Value between 0.0 (no \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1448 specular reflex) and 1.0 (full specular reflex).";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1449 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1450
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1451 case "vertexnormals"
25605 beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1452 s.doc = "Vertex normals are used for lighting the edges or faces if \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1453 the @code{edgelighting} or @code{facelighting} properties are set to \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1454 @qcode{\"gouraud\"}. __modemsg__";
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1455
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1456 case "vertexnormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1457 s.doc = "If this property is set to @qcode{\"auto\"}, \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1458 @code{vertexnormals} are automatically calculated if the @code{edgelighting} \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1459 or @code{facelighting} property are set to @qcode{\"gouraud\"} and at least \
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1460 one @code{light} object is present and visible in the same axes.";
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1461
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1462 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1463 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1464
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1465 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1466 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1467
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1468 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1469 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1470
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1471 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1472 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1473
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1474 endswitch
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1475
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1476 ## Light properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1477 elseif (strcmp (objname, "light"))
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1478 switch (field)
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1479 ## Overridden shared properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1480 case "children"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1481 s.doc = doc_unused;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1482
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1483 ## Specific properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1484 case "color"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1485 s.doc = "Color of the light source. @xref{Colors, ,colorspec}.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1486 s.valid = valid_color;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1487
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1488 case "position"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1489 s.doc = "Position of the light source.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1490
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1491 case "style"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1492 s.doc = "This string defines whether the light emanates from a \
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1493 light source at infinite distance (@qcode{\"infinite\"}) or from a local \
22192 20b225a3ebf8 Update to light (patch #8943) Markus Mützel <markus.muetzel@gmx.de> parents: 21996 diff changeset	1494 point source (@qcode{\"local\"}).";
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1495
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1496 endswitch
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1497
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1498 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1499 elseif (strcmp (objname, "uimenu"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1500 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1501 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1502 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1503 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1504
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1505 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1506 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1507 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1508 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1509 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1510 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1511 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1512 case "position"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1513 case "separator"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1514
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1515 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1516
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1517 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1518 elseif (strcmp (objname, "uicontextmenu"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1519 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1520 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1521 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1522 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1523
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1524 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1525 case "callback"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1526 case "position"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1527
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1528 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1529
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1530 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1531 elseif (strcmp (objname, "uipanel"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1532 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1533 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1534
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1535 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1536 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1537 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1538 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1539 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1540 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1541
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1542 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1543 s.doc = doc_fontname;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1544 s.valid = valid_string;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1545
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1546 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1547 s.doc = doc_fontsize;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1548 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1549
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1550 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1551 s.doc = doc_fontunits;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1552
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1553 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1554 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1555
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1556 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1557 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1558 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1559 case "resizefcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1560 case "shadowcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1561 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1562 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1563 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1564
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1565 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1566
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1567 ## uibuttongroup properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1568 elseif (strcmp (objname, "uibuttongroup"))
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1569 switch (field)
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1570 ## Overridden shared properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1571
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1572 ## Specific properties
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1573 case "backgroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1574 case "bordertype"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1575 case "borderwidth"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1576 case "fontangle"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1577 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1578
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1579 case "fontname"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1580 s.doc = doc_fontname;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1581 s.valid = valid_string;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1582
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1583 case "fontsize"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1584 s.doc = doc_fontsize;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1585 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1586
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1587 case "fontunits"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1588 s.doc = doc_fontunits;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1589
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1590 case "fontweight"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1591 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1592
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1593 case "foregroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1594 case "highlightcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1595 case "position"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1596 case "resizefcn"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1597 case "selectedobject"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1598 case "selectionchangedfcn"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1599 case "shadowcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1600 case "title"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1601 case "titleposition"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1602 case "units"
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1603
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1604 endswitch
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1605
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1606 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1607 elseif (strcmp (objname, "uicontrol"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1608 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1609 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1610
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1611 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1612 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1613 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1614 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1615 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1616 case "extent"
25783 e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1617 s.valid = valid_4elvec;
e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1618 s.printdefault = false;
e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1619
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1620 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1621 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1622
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1623 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1624 s.doc = doc_fontname;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1625 s.valid = valid_string;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1626
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1627 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1628 s.doc = doc_fontsize;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1629 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1630
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1631 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1632 s.doc = doc_fontunits;
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1633
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1634 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1635 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1636
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1637 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1638 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1639 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1640 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1641 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1642 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1643 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1644 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1645 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1646 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1647 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1648 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1649 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1650 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1651
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1652 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1653
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1654 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1655 elseif (strcmp (objname, "uitoolbar"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1656 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1657 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1658 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1659 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1660
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1661 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1662
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1663 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1664 elseif (strcmp (objname, "uipushtool"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1665 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1666 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1667 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1668 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1669
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1670 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1671 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1672 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1673 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1674 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1675 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1676
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1677 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1678
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1679 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1680 elseif (strcmp (objname, "uitoggletool"))
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1681 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1682 ## Overridden shared properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1683 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1684 s.doc = doc_unused;
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1685
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1686 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1687 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1688 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1689 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1690 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1691 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1692 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1693 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1694 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1695
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1696 endswitch
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1697 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1698
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1699 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1700 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1701 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	1702 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1703
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1704 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1705
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1706 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1707 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1708 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1709
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1710 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	1711 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1712 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1713 strout = strrep (strout, "__modemsg__", modemsg);
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1714 fcnmsg = "For information on how to write graphics listener \
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1715 functions see @ref{Callbacks, , @w{Callbacks section}}.";
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	1716 strout = strrep (strout, "__fcnmsg__", fcnmsg);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1717 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1718
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1719 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1720 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1721 if (! strcmp (objname, "root"))
24423 1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility. Rik <rik@octave.org> parents: 24173 diff changeset	1722 ## Use an improbable number to avoid ishghandle to return true for 1
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1723 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1724 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1725
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1726 ## Build a default object to extract its properties list and default values.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1727 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1728 ## Base properties are extracted from hggroup that only have 1 additional
ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1729 ## regular (non-hidden) property, "displayname".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1730 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1731 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1732 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1733 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1734 h = hf;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1735 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1736 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1737 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1738
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1739 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1740 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1741
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1742 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1743 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1744 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1745 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1746 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1747
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1748 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1749 val = getdoc (objname, field, base);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1750
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1751 ## 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	1752 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1753 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1754 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1755
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1756 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1757
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1758 ## 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	1759 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1760 val.valid = sprop.(field);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1761 if (! isempty (val.valid) && iscellstr (val.valid))
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1762 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1763 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	1764 "uniformoutput", false);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1765 val.valid = strjoin (val.valid, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1766 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1767 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1768
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1769 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1770 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1771 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1772
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1773 ## 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	1774 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1775
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1776 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	1777 s = rmfield (s, "displayname");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1778 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1779
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1780 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1781 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1782 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1783
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1784 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1785
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1786 function def = getdefault (h, objname, field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1787 ## 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	1788 ## 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	1789 def = get (h, field);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1790
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1791 ## Don't print default values for graphics handles
25465 26164f8a734a improve type checking in genpropdoc.m (bug #54109) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	1792 if (ishghandle (def) && isscalar (def) && def != 0)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1793 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1794 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1795 if (ischar (def))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1796 def = ['@qcode{"' def '"}'];
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1797 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1798 if ((isvector (def) && numel (def) < 5) \|\| isempty (def))
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1799 ## 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	1800 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1801 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1802 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1803 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1804
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1805 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1806 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1807 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1808 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1809 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1810 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1811 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1812 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1813
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1814 ## Replace texinfo reserved characters
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1815 def = strrep (str, "{", "@{");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1816 def = strrep (def, "}", "@}");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1817 def = strrep (def, "@", "@@");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1818
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1819 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1820 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1821 args = arrayfun (@(x) num2str (x), size (def), "uniformoutput", false);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1822 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1823 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1824 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1825 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1826
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1827 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1828
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1829 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1830 ## 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	1831 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1832 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1833
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1834 ## File header and begining of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1835 str = [warn_autogen() "\n\n@table @asis"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1836
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1837 for ii = 1:nf
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1838 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1839 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1840
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1841 ## @anchor: cross reference using XREFobjnamefield label
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1842 ## Concept index: call info from octave with 'doc ("objname field")'
24549 2c497be89710 doc: Create new Graphic Properties Index (bug #52812). Rik <rik@octave.org> parents: 24534 diff changeset	1843 str = sprintf ("%s@anchor{XREF%s%s}\n@prindex %s %s\n",
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1844 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1845
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1846 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1847 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	1848
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1849 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1850 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1851 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1852 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1853 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1854 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1855
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1856 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1857 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1858 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1859 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1860 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1861 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1862 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1863 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1864
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1865 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1866 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	1867 endfor
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1868
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1869 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1870 str = sprintf ("%s\n@end table", str);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1871
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1872 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1873
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1874 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1875 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	1876 \n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1877 @c Copyright (C) 2014-2018 Pantxo Diribarne\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1878 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1879 @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	1880 @c\n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1881 @c Octave is free software: you can redistribute it and/or modify it\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1882 @c under the terms of the GNU General Public License as published by\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1883 @c the Free Software Foundation, either version 3 of the License, or\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1884 @c (at your option) any later version.\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1885 @c\n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1886 @c Octave is distributed in the hope that it will be useful, but\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1887 @c WITHOUT ANY WARRANTY; without even the implied warranty of\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1888 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\
194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1889 @c GNU General Public License for more details.\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1890 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1891 @c You should have received a copy of the GNU General Public License\n\
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1892 @c along with Octave; see the file COPYING. If not, see\n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	1893 @c <https://www.gnu.org/licenses/>.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1894 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1895
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1896 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1897 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1898 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1899 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1900 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1901 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1902 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1903 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1904 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1905 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1906 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1907 endif
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1908
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1909 endfunction

Mercurial > octave

annotate doc/interpreter/genpropdoc.m @ 25867:49ffa78f9243