octave: doc/interpreter/genpropdoc.m annotate

annotate doc/interpreter/genpropdoc.m @ 30622:18a9b3c7b63b

legend.m: Implement "itemhitfcn" property * gendpropdoc.m: Document new property * legend.m (execute_item_hit): New callback function. (create_item): Change "buttondownfcn" of legend item objects to run execute_item_hit.

author	Pantxo Diribarne <pantxo.diribarne@gmail.com>
date	Sun, 09 Jan 2022 16:57:26 +0100
parents	796f54d4ddbf
children	4c0c02102ba9

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	3 ## Copyright (C) 2014-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27254 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	7 ##
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	8 ## This file is part of Octave.
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	10 ## 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	11 ## 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	12 ## 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	13 ## (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	14 ##
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22507 diff changeset	15 ## 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	16 ## 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	17 ## 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	18 ## 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	19 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	20 ## 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	21 ## 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	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	25
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	26 ## -- texinfo --
21319 8880d93010d8 Remove further uses of CLASS field in @deftypefn macro. Rik <rik@octave.org> parents: 20930 diff changeset	27 ## @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	28 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	29 ## 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	30 ## 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	31 ## (see doc/interpreter/graphics_properties.mk).
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	32 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	33 ## 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	34 ## 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	35 ## property.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	36 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	37 ## @seealso{}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	38 ## @end deftypefn
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	39
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	40 function genpropdoc (objname, fname = "", props = {})
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	41 objnames = {"root", "figure", "axes", "legend", ...
28286 496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	42 "image", "light", "line", "patch", "scatter", "surface", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	43 "text", "uibuttongroup", "uicontextmenu", "uicontrol", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	44 "uipanel", "uimenu", "uipushtool", "uitable", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	45 "uitoggletool", "uitoolbar"
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	46 };
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	47
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	48 ## Base properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	49 base = getstructure ("base");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	50
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	51 ## Object properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	52 if (any (strcmp (objname, objnames)))
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	53 obj = getstructure (objname, base, props);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	54 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	55 error ("genpropdoc: unknown object %s", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	56 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	57
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	58 ## Docstring
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	59 str = printdoc (objname, obj, ! isempty (props));
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	60
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	61 if (! isempty (fname))
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	62 fid = fopen (fname, "w+");
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	63 if (fid < 0)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	64 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	65 endif
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	66 else
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	67 fid = stdout;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	68 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	69
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	70 fprintf (fid, str);
19792 4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	71
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	72 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	73 fclose (fid);
4f6ae6b94abe make --enable-silent-rules configure option more useful John W. Eaton <jwe@octave.org> parents: 19776 diff changeset	74 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	75
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	76 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	77
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	78 function s = getdoc (objname, field, base)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	79 ## 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	80 ##
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	81 ## -"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	82 ## 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	83 ## "__objname__" : replaced by the current object name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	84 ## "__prop__" : replaced by the current property name;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	85 ## "__modemsg__" : replaced by a message explaining that
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	86 ## 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	87 ## 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	88 ## 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	89 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	90 ## -"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	91 ## 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	92 ## 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	93 ## 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	94 ## retrieved using set function.
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	95 ##
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	96 ## -"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	97 ## retrieved using get function.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	98 ##
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	99 ## -"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	100 ## default value should be printed. It is useful for properties
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	101 ## like root "screendepth" that default to screen dependent values.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	102
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	103 packopt = @(c) strjoin (c, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	104 markdef = @(s) ["@{" s "@}"];
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	105
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	106 ## Some generic templates:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	107 valid_color = "colorspec";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	108 valid_handle = "graphics handle";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	109 valid_string = "string";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	110 valid_fcn = packopt ({"string", "function handle"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	111 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	112 valid_2elvec = "two-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	113 valid_3elvec = "three-element vector";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	114 valid_4elvec = "four-element vector";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	115 valid_vecmat = packopt ({"vector", "matrix"});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	116 valid_scalmat = packopt ({"scalar", "matrix"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	117
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	118 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	119 __prop__ is unused.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	120 doc_unused = "__prop__ is unused.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	121
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	122 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	123 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	124 @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	125 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	126 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	127 font in your system. If none is found then text is rendered using a \
28393 0824d92a449d Document fc-cache must be run after installing new fonts (bug #58432) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27957 diff changeset	128 default sans serif font (same as the default @qcode{\"*\"} value).\n\n\
0824d92a449d Document fc-cache must be run after installing new fonts (bug #58432) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27957 diff changeset	129 Programming Note: On systems that don’t use FontConfig natively \
0824d92a449d Document fc-cache must be run after installing new fonts (bug #58432) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27957 diff changeset	130 (all but Linux), the font cache is built when Octave is installed. \
0824d92a449d Document fc-cache must be run after installing new fonts (bug #58432) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27957 diff changeset	131 You will need to run @code{system (\"fc-cache -fv\")} manually after \
0824d92a449d Document fc-cache must be run after installing new fonts (bug #58432) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27957 diff changeset	132 installing new fonts.";
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	133 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	134 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	135 text rendering.";
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	136
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	137 ## Initialize structure
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	138 if (isfield (base, field))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	139 s = base.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	140 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	141 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	142 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	143
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	144 ## 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	145 ## 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	146 ## 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	147 ## to be rewritten for this object.
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	148 if (strcmp (objname, "base"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	149 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	150 case "beingdeleted"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	151 case "busyaction"
24626 58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	152 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	153 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	154 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	155 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	156 \@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	157 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	158 (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	159 @xref{Callbacks, , @w{Callbacks section}}.";
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	160
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	161 case "buttondownfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	162 s.doc = "__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	163 s.valid = valid_fcn;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	164
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	165 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	166 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	167 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	168
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	169 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	170 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	171 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	172
28298 e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28286 diff changeset	173 case "contextmenu"
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28286 diff changeset	174 s.doc = "Graphics handle of the uicontextmenu object that is \
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28286 diff changeset	175 currently associated to this __objname__ object.";
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28286 diff changeset	176 s.valid = valid_handle;
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28286 diff changeset	177
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	178 case "createfcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	179 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	180 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	181 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	182 'disp (\"__objname__ created!\")')}.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	183 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	184
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	185 case "deletefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	186 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	187 is deleted.\n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	188 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	189
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	190 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	191 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	192 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	193
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	194 case "hittest"
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	195 s.doc = "Specify whether __objname__ processes mouse events \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	196 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	197 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	198 the uicontextmenu, and eventually becoming the root \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	199 @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	200 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	201 property. @xref{XREF__objname__pickableparts, , @w{pickableparts property}}.";
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	202
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	203 case "interruptible"
24626 58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24549 diff changeset	204 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	205 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	206 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	207 @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	208 @xref{Callbacks, , @w{Callbacks section}}.";
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	209
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	210 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	211 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	212 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	213
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	214 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	215 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	216 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	217 __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	218 @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	219 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	220 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	221 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	222 will determine how they are processed. \
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	223 @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	224
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	225 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	226 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	227 case "tag"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	228 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	229 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	230
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	231 case "type"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	232 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	233 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	234 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	235 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	236
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	237 case "userdata"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	238 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	239 s.valid = "Any Octave data";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	240
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	241 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	242 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	243 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	244 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	245
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	246 ## Root properties:
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	247 elseif (strcmp (objname, "root"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	248 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	249 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	250 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	251 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	252 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	253 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	254 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	255
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	256 case "parent"
26878 3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object". Rik <rik@octave.org> parents: 26877 diff changeset	257 s.doc = "Root object has no parent graphics object. __prop__ \
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	258 is always empty.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	259
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	260 case "hittest"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	261 s.doc = doc_unused;
24634 ab2321d4ba03 maint: strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 24626 diff changeset	262
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	263 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	264 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	265
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	266 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	267 case "callbackobject"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	268 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	269 s.valid = valid_handle;
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 "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	272 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	273 s.valid = valid_handle;
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 "diary"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	276 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	277 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	278
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	279 case "diaryfile"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	280 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	281 @xref{XREFdiary, , @w{diary function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	282 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	283
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	284 case "echo"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	285 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	286 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	287
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	288 case "errormessage"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	289 s.doc = "The last error message raised. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	290 @xref{XREFlasterr, , @w{lasterr function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	291 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	292
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	293 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	294 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	295
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	296 case "format"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	297 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	298 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	299
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	300 case "formatspacing"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	301 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	302 @xref{XREFformat, , @w{format function}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	303
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	304 case "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	305 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	306
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	307 case "monitorpositions"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	308 s.doc = doc_unused;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	309 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	310
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	311 case "pointerlocation"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	312 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	313 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	314
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	315 case "pointerwindow"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	316 s.doc = doc_unused;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	317 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	318
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	319 case "recursionlimit"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	320 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	321 recursively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	322 @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	323 s.valid = "double";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	324
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	325 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	326 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	327 s.printdefault = false;
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 "screenpixelsperinch"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	330 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	331 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	332
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	333 case "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	334 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	335 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	336
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	337 case "showhiddenhandles"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	338 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	339 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	340 @code{handlevisibility} property.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	341
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	342 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	343 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	344
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	345 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	346 elseif (strcmp (objname, "figure"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	347 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	348 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	349 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	350 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	351
24523 501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	352 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	353 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24462 diff changeset	354
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	355 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	356 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	357 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	358
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	359 case "closerequestfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	360 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	361 @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	362 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	363
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	364 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	365 s.doc = "Color of the figure background. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	366 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	367 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	368
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	369 case "colormap"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	370 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	371 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	372
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	373 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	374 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	375 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	376
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	377 case "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	378 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	379
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	380 case "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	381 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	382
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	383 case "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	384 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	385 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	386 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	387 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	388 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	389 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	390 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	391 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	392 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	393 @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	394 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	395 @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	396 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	397 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	398 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	399
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	400 case "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	401 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	402
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	403 case "filename"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	404 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	405 s.valid = valid_string;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	406
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	407 case "graphicssmoothing"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	408 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	409
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	410 case "integerhandle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	411 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	412
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	413 case "inverthardcopy"
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	414 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	415
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	416 case "keypressfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	417 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	418 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	419 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	420 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	421
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	422 case "keyreleasefcn"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	423 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	424 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	425 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	426 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	427 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	428 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	429 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	430 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	431 @item Key:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	432 Lowercase value of the key\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	433 @item Modifier:\n\
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	434 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	435 key.\n\
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	436 @end table\
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	437 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	438 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	439
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	440 case "menubar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	441 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	442 of the figure.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	443
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	444 case "name"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	445 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	446 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	447 property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	448 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	449
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	450 ## 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	451 #case "number"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	452 # s.doc = "Number of current figure (RO).";
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	453
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	454 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	455 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	456 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	457 @xref{XREFnewplot, , @w{newplot function}}.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	458
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	459 case "numbertitle"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	460 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	461 value in the figure title bar.";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	462
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	463 case "outerposition"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	464 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	465 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	466 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	467 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	468 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	469 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	470
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	471 case "paperorientation"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	472 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	473 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	474 @code{papersize} and @code{paperposition} reverse order \
21948 241d39c66e8f Update graphics properties for figure object. Rik <rik@octave.org> parents: 21931 diff changeset	475 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	476 @code{\"landscape\"}.";
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	477
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	478 case "paperposition"
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	479 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	480 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	481 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	482 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	483 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	484 @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	485 ignored. \
20930 b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties. Ben Abbott <bpabbott@mac.com> parents: 20905 diff changeset	486 __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	487 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	488
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	489 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	490 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	491 @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	492 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	493 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	494 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	495
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	496 case "papersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	497 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	498 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	499 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	500 @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	501 @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	502 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	503 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	504 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	505
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	506 case "papertype"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	507 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	508 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	509 with the @code{paperorientation} property.";
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 "paperunits"
20886 3c986b688596 Improve the documentation for the figure paper properties. Ben Abbott <bpabbott@mac.com> parents: 20715 diff changeset	512 s.doc = "The unit used to compute the @code{paperposition} property. \
29002 6075738dc529 Don't reference invalid "paperunits" value "pixels" (bug #59351). Markus Mützel <markus.muetzel@gmx.de> parents: 28660 diff changeset	513 The conversion from physical units (e.g., @code{\"inches\"}) is dependent on \
6075738dc529 Don't reference invalid "paperunits" value "pixels" (bug #59351). Markus Mützel <markus.muetzel@gmx.de> parents: 28660 diff changeset	514 the @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	515
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	516 case "pointer"
27099 2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	517 s.doc = "Name of the mouse pointer shape associated with the canvas \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	518 of the figure. When __prop__ is \"custom\", the shape is determined by \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	519 the @code{pointershapecdata} property.\n\n\
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	520 __prop__ has no effect when the figure is in zoom, pan, or rotate mode. \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	521 In this case, Octave automatically uses a pointer shape appropriate \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	522 to the mode.";
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	523
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	524 case "pointershapecdata"
27099 2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	525 s.doc ="m-by-m matrix defining a custom pointer. Each \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	526 element defines a pixel with the element (1,1) representing the \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	527 top-left pixel. A value of 1 is colored black, a value of 2 is colored white, \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	528 and all other values are rendered as transparent.";
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	529 s.valid = "16-by-16 or 32-by-32 Matrix";
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	530
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	531 case "pointershapehotspot"
27099 2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	532 s.doc ="For custom pointers only __prop__ defines the row and column \
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	533 of the pixel in @code{pointershapecdata} that is used as the pointer location.";
2cd31365c84a Implement "pointer" and related figure properties for Qt toolkit (bug #56347) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27097 diff changeset	534 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	535
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	536 case "position"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	537 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	538 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	539 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	540 @xref{XREFfigureunits, , @w{units property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	541 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	542
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	543 case "renderer"
27956 2310164737b3 fix many spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 27088 diff changeset	544 s.doc = "Rendering engine used for printing when @code{renderermode} \
25998 8d2b3e3ff182 print.m: Implement "-opengl", "-painters" and "-RGBImage" options (bug #52866) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25980 diff changeset	545 is \"manual\". __modemsg__.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	546
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	547 case "renderermode"
27956 2310164737b3 fix many spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 27088 diff changeset	548 s.doc = "Control whether the rendering engine used for printing is \
25998 8d2b3e3ff182 print.m: Implement "-opengl", "-painters" and "-RGBImage" options (bug #52866) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25980 diff changeset	549 chosen automatically or specified by the @code{renderer} property. \
8d2b3e3ff182 print.m: Implement "-opengl", "-painters" and "-RGBImage" options (bug #52866) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25980 diff changeset	550 @xref{XREFprint, , @w{print function}}.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	551
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	552 case "resize"
25929 ea5182364e5f Implement "resize" property for Qt figures (bug #54774) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25867 diff changeset	553 s.doc = "Control whether the figure can be resized by dragging the \
ea5182364e5f Implement "resize" property for Qt figures (bug #54774) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25867 diff changeset	554 window borders and corners using a mouse. When __prop__ is @qcode{\"off\"} \
ea5182364e5f Implement "resize" property for Qt figures (bug #54774) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25867 diff changeset	555 mouse interactions are disabled but the figure can still be resized by \
ea5182364e5f Implement "resize" property for Qt figures (bug #54774) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25867 diff changeset	556 changing its @qcode{\"position\"} property.";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	557
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	558 case "resizefcn"
22506 84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation Rik <rik@octave.org> parents: 22323 diff changeset	559 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	560 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	561
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	562 case "selectiontype"
27135 bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	563 s.doc = "Selection type of the latest mouse click.\n\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	564 __prop__ may take different values depending on the combination of mouse \
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	565 button and keyboard modifier that were used:\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	566 @table @code\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	567 @item normal:\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	568 Left-click.\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	569 @item alt:\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	570 Right-click or Ctrl+Left-click.\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	571 @item extend:\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	572 Shitf+Left-click, Middle click, or combined Left-click and Right-click.\n\
bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	573 @item open:\n\
27140 142084841f23 doc: Silence two TexInfo warnings. Rik <rik@octave.org> parents: 27135 diff changeset	574 Double Left-click.\n\
27135 bf2f533d2d45 Document the figure "selectiontype" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27125 diff changeset	575 @end table";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	576
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	577 case "sizechangedfcn"
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	578 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	579 \n\n__fcnmsg__";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	580 s.valid = valid_fcn;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	581
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	582 case "toolbar"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	583 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	584 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	585
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	586 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	587 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	588 @code{outerposition} properties.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	589
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	590 case "windowbuttondownfcn"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	591 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	592 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	593 s.valid = valid_fcn;
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 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	596 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	597 @w{windowbuttonupfcn property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	598 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	599
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	600 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	601 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	602 @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	603 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	604 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	605 @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	606 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	607 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	608
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	609 case "windowkeypressfcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	610 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	611 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	612 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	613
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	614 case "windowkeyreleasefcn"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	615 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	616 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	617 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	618
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	619 case "windowscrollwheelfcn"
27125 d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	620 s.doc = "Function that is executed when a user manipulates \
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	621 the mouse wheel over this figure. \
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	622 The function is called with two input arguments. The first \
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	623 argument holds the handle of the calling figure. The second argument holds \
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	624 an event structure which has the following members:\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	625 @table @code\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	626 @item VerticalScrollCount:\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	627 The number of wheel steps, typically 1 when scrolling down and -1 when \
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	628 scrolling up.\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	629 @item VerticalScrollAmount:\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	630 The number of lines a wheel step should scroll. This value is always 3.\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	631 @item EventName:\n\
27140 142084841f23 doc: Silence two TexInfo warnings. Rik <rik@octave.org> parents: 27135 diff changeset	632 The event name which is \"WindowScrollWheel\".\n\
27125 d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	633 @end table\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27099 diff changeset	634 \n\n__fcnmsg__";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	635 s.valid = valid_fcn;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	636
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	637 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	638 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	639 @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	640 @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	641 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	642 @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	643 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	644 @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	645 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	646 @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	647 \n\
d6370831d37f Set Qt Figure window modal/normal state based on WindowStyle (Bug #48160) John Donoghue <john.donoghue@ieee.org> parents: 21948 diff changeset	648 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	649
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	650 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	651
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	652 ## Axes properties
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	653 elseif (strcmp (objname, "axes") \|\| strcmp (objname, "legend"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	654 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	655 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	656 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	657 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	658
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	659 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	660 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	661 s.doc = sprintf (doc_notimpl, "Transparency");
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	662
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	663 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	664 case "ambientlightcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	665 s.doc = doc_unused;
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	666
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	667 case "box"
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	668 s.doc = "Control whether the __objname__ has a surrounding box.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	669
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	670 case "boxstyle"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	671 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	672 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	673
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	674 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	675 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	676
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	677 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	678 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	679 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	680
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	681 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	682 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	683 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	684
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	685 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	686 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	687 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	688
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	689 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	690 case "clim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	691 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	692 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	693 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	694
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	695 case "climmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	696
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	697 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	698 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	699
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	700 case "color"
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	701 s.doc = "Color of the __objname__ background. \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	702 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	703 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	704
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	705 case "colororder"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	706 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	707 coloring.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	708 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	709
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	710 case "colororderindex"
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 "currentpoint"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	714 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	715 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	716 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	717 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	718 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	719 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	720 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	721 perpendicular to the screen.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	722 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	723
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	724 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	725 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	726 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	727 @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	728 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	729 @xref{XREFdaspect, , daspect function}. __modemsg__.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	730 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	731
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	732 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	733 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	734 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	735
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	736 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	737 s.doc = doc_fontname;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	738 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	739
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	740 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	741 s.doc = doc_fontsize;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	742 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	743
26858 0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	744 case "fontsmoothing"
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	745 s.doc = "Control whether any text associated with __objname__ is anti-aliased.";
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	746
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	747 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	748 s.doc = doc_fontunits;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	749
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	750 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	751 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	752
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	753 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	754 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	755
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	756 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	757 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	758
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	759 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	760 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	761
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	762 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	763 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	764
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	765 case "gridlinestyle"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	766
28302 1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28298 diff changeset	767 case "innerposition"
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28298 diff changeset	768 s.doc = "The @qcode{\"innerposition\"} property is the same as the \
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28298 diff changeset	769 @ref{XREFaxesposition, , @w{@qcode{\"position\"} property}}.";
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28298 diff changeset	770 s.valid = valid_4elvec;
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28298 diff changeset	771
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	772 case "labelfontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	773 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	774 label fontsize";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	775
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	776 case "layer"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	777 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	778 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	779
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	780 case "linestyleorder"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	781 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	782
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	783 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	784 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	785
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	786 case "linewidth"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	787 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	788
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	789 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	790 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	791
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	792 case "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	793 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	794
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	795 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	796 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	797
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	798 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	799 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	800
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	801 case "minorgridlinestyle"
19776 4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom". Rik <rik@octave.org> parents: 19746 diff changeset	802 case "mousewheelzoom"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	803 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	804 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	805
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	806 case "nextplot"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	807 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	808 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	809 @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	810 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	811 @xref{XREFhold, , @w{hold function}}.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	812
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	813 case "outerposition"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	814 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	815 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	816 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	817 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	818 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	819 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	820 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	821 @xref{XREFaxesposition, , @w{position property}}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	822 s.valid = valid_4elvec;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	823 case "plotboxaspectratio"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	824 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	825 __modemsg__.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	826
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	827 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	828 case "position"
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	829 if (strcmp (objname, "legend"))
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	830 s.doc = "Specify the position of the legend excluding its title. \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	831 The four elements of the vector are the coordinates of the lower left corner \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	832 and width and height of the legend. Changing this property also \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	833 switches the @qcode{\"location\"} to @qcode{\"none\"}.";
28660 dc80e087df4b maint: Strip trailing spaces from files. Rik <rik@octave.org> parents: 28658 diff changeset	834 s.printdefault = false;
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	835 else
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	836 s.doc = "Specify the position of the plot excluding titles, \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	837 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	838 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	839 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	840 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	841 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	842 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	843 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	844 endif
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	845 s.valid = valid_4elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	846
28303 af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	847 case "positionconstraint"
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	848 s.doc = "Specify which of @qcode{\"innerposition\"} or \
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	849 @qcode{\"outerposition\"} properties takes precedence when axes \
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	850 annotations extent changes. \
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	851 @xref{XREFaxesinnerposition, , @w{@qcode{\"innerposition\"} property}}, \
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	852 and @ref{XREFaxesouterposition, , @w{@qcode{\"outerposition\"} property}}.";
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). Markus Mützel <markus.muetzel@gmx.de> parents: 28302 diff changeset	853
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	854 case "projection"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	855 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	856
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	857 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	858 s.doc = doc_unused;
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	859
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	860 case "tickdir"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	861 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	862 box or \"out\". __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	863
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	864 case "tickdirmode"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	865
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	866 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	867 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	868 @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	869
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	870 case "ticklength"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	871 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	872 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	873 s.valid = valid_2elvec;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	874
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	875 case "tightinset"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	876 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	877 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	878 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	879 s.printdefault = false;
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	880
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	881 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	882 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	883 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	884
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	885 case "titlefontsizemultiplier"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	886 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	887 label fontsize";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	888 s.valid = "positive scalar";
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	889
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	890 case "titlefontweight"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	891 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	892
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	893 case "units"
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	894 if (strcmp (objname, "legend"))
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	895 s.doc = "Units used to interpret the @qcode{\"position\"}, \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	896 property.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	897 else
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	898 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	899 @qcode{\"outerposition\"}, and @qcode{\"tightinset\"} properties.";
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	900 endif
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	901
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	902 case "view"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	903 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	904 the viewpoint for three-dimensional plots";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	905 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	906
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	907 case "xaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	908 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	909
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	910 case "xcolor"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	911 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	912 __modemsg__.";
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	913 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	914
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	915 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	916
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	917 case "xdir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	918 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	919 to right.";
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	920
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	921 case "xgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	922 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	923
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	924 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	925 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	926 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	927
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	928 case "xlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	929 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	930 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	931 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	932
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	933 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	934 case "xminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	935 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	936
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	937 case "xminortick"
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	938 case "xscale"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	939 case "xtick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	940 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	941 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	942 s.printdefault = false;
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 "xticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	945 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	946 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	947
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	948 case "xticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	949 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	950 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	951
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	952 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	953 case "yaxislocation"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	954 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	955
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	956 case "ycolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	957 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	958 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	959
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	960 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	961
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	962 case "ydir"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	963 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	964 to top.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	965
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	966 case "ygrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	967 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	968
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	969 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	970 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	971 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	972
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	973 case "ylim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	974 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	975 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	976 s.valid = valid_2elvec;
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 "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	979 case "yminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	980 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	981
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	982 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	983 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	984 case "ytick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	985 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	986 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	987 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	988
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	989 case "yticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	990 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	991 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	992
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	993 case "yticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	994 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	995 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	996
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	997 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	998 case "zcolor"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	999 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	1000 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	1001
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1002 case "zcolormode"
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1003 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1004 case "zgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	1005 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	1006
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1007 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1008 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	1009 s.valid = valid_handle;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1010
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1011 case "zlim"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1012 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	1013 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	1014 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1015
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1016 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1017 case "zminorgrid"
19746 97690ea6f57a Add documentation for axes property "mouse_wheel_zoom". Rik <rik@octave.org> parents: 19697 diff changeset	1018 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	1019
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1020 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1021 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1022 case "ztick"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1023 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	1024 s.valid = "vector";
20463 ab4090316e6d Don't put default xtick vector size in documentation (bug #45725). Rik <rik@octave.org> parents: 20101 diff changeset	1025 s.printdefault = false;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1026
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1027 case "zticklabel"
19407 86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence. Rik <rik@octave.org> parents: 19325 diff changeset	1028 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	1029 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1030
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1031 case "zticklabelmode"
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1032 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1033 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	1034
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1035 case "ztickmode"
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1036
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1037 ## Legend specific properties
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1038 case "autoupdate"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1039 s.doc = "Control whether the number of legend items is updated \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1040 automatically when objects are added to (or deleted from) the peer axes.\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1041 For example:\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1042 @example\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1043 @group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1044 ## Create a single plot with its legend.\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1045 figure ();\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1046 plot (1:10);\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1047 legend (\"Slope 1\");\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1048 ## Add another plot and specify its displayname so that\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1049 ## the legend is correctly updated.\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1050 hold on;\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1051 plot ((1:10) * 2, \"displayname\", \"Slope 2\");\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1052 ## Stop automatic updates for further plots.\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1053 legend (\"autoupdate\", \"off\");\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1054 plot ((1:10) * 3);\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1055 @end group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1056 @end example";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1057
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1058 case "edgecolor"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1059 s.doc = "Control the color of the legend outline.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1060 s.valid = valid_color;
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1061
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1062 case "interpreter"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1063 s.doc = "Control if and eventually how labels strings are interpreted \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1064 before rendering.\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1065 @xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1066
30622 18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1067 case "itemhitfcn"
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1068 s.doc = "Callback function which is executed when a legend item \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1069 is clicked. @xref{Callbacks, , @w{Callbacks section}}.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1070 \n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1071 The callback function must have the following prototype \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1072 @code{fcn (hlegend, evnt)}, where @code{hlegend} is the legend object handle \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1073 and @code{evnt} is a structure with the following fields:\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1074 @table @code\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1075 @item Peer\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1076 Handle of the plot object to which the clicked item is associated.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1077 @item Region\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1078 May be @qcode{\"icon\"} or @qcode{\"label\"} depending on which part of \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1079 the item is clicked.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1080 @item SelectionType\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1081 One of @qcode{\"normal\"}, @qcode{\"extend\"}, @qcode{\"open\"}, or \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1082 @qcode{\"alt\"}. \
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1083 @xref{XREFfigureselectiontype, , @w{Figure @qcode{\"selectiontype\"}}}.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1084 @item Source\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1085 Handle of the legend object.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1086 @item EventName\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1087 Name is @qcode{\"ItemHit\"}.\n\
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1088 @end table";
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	1089
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1090 case "location"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1091 s.doc = "Control the location of the legend.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1092
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1093 case "numcolumns"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1094 s.doc = "Control the number of columns used in the layout of the legend items. \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1095 For example:\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1096 @example\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1097 @group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1098 figure ();\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1099 plot (rand (30));\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1100 legend (\"numcolumns\", 3);\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1101 @end group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1102 @end example\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1103 __modemsg__.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1104 s.valid = "scalar interger";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1105
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1106 case "orientation"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1107 s.doc = "Control whether the legend items are arranged vertically \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1108 (column-wise) or horizontally (row-wise).";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1109
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1110 case "string"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1111 s.doc = "List of labels for the legend items. For example:\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1112 @example\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1113 @group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1114 figure ();\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1115 plot (rand (20));\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1116 ## Let legend choose names automatically\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1117 hl = legend ();\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1118 ## Selectively change some names\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1119 str = get (hl, \"string\");\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1120 str(1:5:end) = \"Garbage\";\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1121 set (hl, \"string\", str);\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1122 @end group\n\
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1123 @end example";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1124 s.valid = valid_cellstring;
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1125 s.printdefault = false;
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1126
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1127 case "textcolor"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1128 s.doc = "Control the color of the text strings for legend items.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1129 s.valid = valid_color;
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1130
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1131 case "textposition"
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1132 s.doc = "Control whether text strings are displayed on the left or \
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1133 right of their corresponding icon.";
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	1134
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1135 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1136
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1137 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1138 elseif (strcmp (objname, "line"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1139 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1140 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1141 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1142 s.doc = doc_unused;
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 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1145 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1146 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	1147 s.valid = valid_color;
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 "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1150 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	1151 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1152
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1153 case "interpreter"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1154
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1155 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1156 s.doc = "@xref{Line Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1157
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1158 case "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1159 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	1160
22759 39f39eb4e476 Implement "linejoin" property (bug #48387) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22755 diff changeset	1161 case "linejoin"
39f39eb4e476 Implement "linejoin" property (bug #48387) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22755 diff changeset	1162 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	1163 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	1164
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1165 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1166 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	1167 @xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1168
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1169 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1170 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	1171 @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	1172 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	1173 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	1174
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1175 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1176 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	1177 @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	1178 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	1179 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	1180
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1181 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1182 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	1183 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1184
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1185 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1186 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	1187 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1188
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1189 case "xdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1190 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	1191 x data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1192 s.valid = valid_string;
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 "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1195 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	1196 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1197
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1198 case "ydatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1199 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	1200 y data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1201 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1202
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1203 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1204 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	1205 s.valid = "vector";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1206
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1207 case "zdatasource"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1208 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	1209 z data.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1210 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1211
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1212 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1213
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1214 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1215 elseif (strcmp (objname, "text"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1216 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1217 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1218 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1219 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1220
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1221 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1222 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	1223 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	1224 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1225 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1226
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1227 case "color"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1228 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	1229 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1230
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1231 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1232 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	1233 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	1234 @xref{Colors, , colorspec}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1235 s.valid = valid_color;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1236
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1237 case "editing"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1238 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1239
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1240 case "extent"
23202 c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 22507 diff changeset	1241 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	1242 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	1243 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	1244 s.printdefault = false;
23394 7ca04e85f9e3 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23219 diff changeset	1245
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1246 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1247 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1248
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1249 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1250 s.doc = doc_fontname;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1251 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1252
26858 0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	1253 case "fontsmoothing"
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	1254 s.doc = "Control whether anti-aliasing is used when rendering text.";
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26376 diff changeset	1255
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1256 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1257 s.doc = doc_fontsize;
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1258 s.valid = "scalar";
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 "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1261 s.doc = doc_fontunits;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1262
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1263 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1264 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1265
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1266 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1267 case "interpreter"
20285 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1268 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	1269 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20258 diff changeset	1270 @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	1271
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1272 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	1273 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	1274
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1275 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	1276 s.doc = "Width of the outline.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 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 "margin"
24173 730227072acb Add support for text background area for OpenGL toolkits (bug #39692). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 24154 diff changeset	1280 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	1281 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	1282 of the @qcode{\"fontunits\"} property.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1283 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1284
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1285 case "position"
27088 15d3f8857326 doc: Specify "position" property for text objects is a three-element vector(bug #56303). Rik <rik@octave.org> parents: 26878 diff changeset	1286 s.doc = "Vector @code{[X0 Y0 Z0]} where X0, Y0, and Z0 indicate the \
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1287 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	1288 @code{horizontalalignment}.";
27088 15d3f8857326 doc: Specify "position" property for text objects is a three-element vector(bug #56303). Rik <rik@octave.org> parents: 26878 diff changeset	1289 s.valid = valid_3elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1290
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1291 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1292 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	1293 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1294 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1295
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1296 case "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1297 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1298 s.valid = valid_string;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1299
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1300 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1301 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1302 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1303
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1304 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1305 elseif (strcmp (objname, "image"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1306 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1307 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1308 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1309 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1310
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1311 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1312 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1313 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1314 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1315
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1316 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1317 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	1318
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1319 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1320 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1321
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1322 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1323 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1324 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	1325 s.valid = valid_cellstring;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1326
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1327 case "xdata"
25980 221c039aa415 Fix rendering of images with permuted x/ydata (bug #49756). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25929 diff changeset	1328 s.doc = "Two-element vector @code{[xfirst xlast]} 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	1329 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	1330 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1331 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	1332 of @code{[1 columns(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1333 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1334
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1335 case "ydata"
25980 221c039aa415 Fix rendering of images with permuted x/ydata (bug #49756). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25929 diff changeset	1336 s.doc = "Two-element vector @code{[yfirst ylast]} 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	1337 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	1338 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1339 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	1340 of @code{[1 rows(image)]}.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1341 s.valid = valid_2elvec;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1342
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1343 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1344
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1345 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1346 elseif (strcmp (objname, "surface"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1347 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1348 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1349 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1350 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1351
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1352 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1353 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1354 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1355 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1356
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1357 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1358 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	1359
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1360 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1361 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	1362 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1363
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1364 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1365 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	1366 @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	1367 @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	1368
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1369 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1370 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1371
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1372 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1373 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1374 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1375 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	1376 diffuse reflex) and 1.0 (full diffuse reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1377 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1378
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1379 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1380 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	1381
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1382 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1383 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1384 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1385
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1386 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1387 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1388 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	1389 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	1390 @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	1391 @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	1392 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	1393 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1394
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1395 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	1396 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	1397 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	1398 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	1399 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	1400 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	1401 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	1402 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	1403 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	1404 "@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	1405 "@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	1406 "@qcode{\"texturemap\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1407
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1408 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1409 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1410 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	1411 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	1412 @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	1413 @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	1414 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	1415 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1416
25867 49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1417 case "facenormals"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1418 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	1419 @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	1420 @qcode{\"flat\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1421
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1422 case "facenormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1423 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	1424 @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	1425 @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	1426 @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	1427
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1428 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1429 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1430 s.doc = "@xref{Line Styles}.";
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 "linewidth"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1433 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	1434
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1435 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1436 s.doc = "@xref{Marker Styles}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1437
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1438 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1439 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1440 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1441
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1442 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1443 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1444 @w{line markerfacecolor property}}.";
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 "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1447 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1448 @w{line markersize property}}.";
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 "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1452 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1453 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	1454 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	1455 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1456
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1457 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1458 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	1459 the more the reflex is spread out.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1460 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1461
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1462 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1463 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	1464 specular reflex) and 1.0 (full specular reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1465 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1466
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1467 case "vertexnormals"
25867 49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1468 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	1469 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	1470 @qcode{\"gouraud\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1471
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1472 case "vertexnormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024). Markus Mützel <markus.muetzel@gmx.de> parents: 25861 diff changeset	1473 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	1474 @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	1475 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	1476 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	1477
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1478 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1479 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1480
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1481 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1482 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1483 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1484
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1485 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1486 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1487 s.valid = "matrix";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1488
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1489 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1490 endswitch
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1491
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1492 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1493 elseif (strcmp (objname, "patch"))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1494 switch (field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1495 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1496 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1497 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1498
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1499 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1500 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1501 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	1502
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1503 case "ambientstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1504 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	1505 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1506
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1507 case "backfacelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1508 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	1509 @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	1510 @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	1511
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1512 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1513 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	1514 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	1515 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1516 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	1517 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	1518 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1519 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	1520 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	1521 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1522 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	1523 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	1524 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1525
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1526 case "diffusestrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1527 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	1528 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	1529 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1530
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1531 case "displayname"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1532 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	1533
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1534 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1535 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1536 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1537
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1538 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1539 case "edgelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1540 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	1541 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	1542 @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	1543 @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	1544 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	1545 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1546
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1547 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	1548 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	1549 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	1550 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	1551 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	1552 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	1553 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	1554 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	1555 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	1556 "@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	1557 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1558
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1559 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1560 ## 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	1561 ## 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	1562 s.valid = packopt ({markdef(valid_color), ...
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1563 "@qcode{\"none\"}", ...
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1564 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1565 "@qcode{\"interp\"}"});
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1566
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1567 case "facelighting"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1568 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	1569 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	1570 @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	1571 @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	1572 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	1573 @qcode{\"gouraud\"}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1574
25605 beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1575 case "facenormals"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1576 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	1577 @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	1578 @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	1579
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1580 case "facenormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1581 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	1582 @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	1583 @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	1584 @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	1585
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1586 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1587 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1588
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1589 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1590 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1591 s.valid = valid_scalmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1592
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1593 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1594 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1595 s.doc = doc_unused;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1596
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1597 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1598 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1599 case "marker"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1600 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	1601
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1602 case "markeredgecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1603 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1604 @w{line markeredgecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1605
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1606 case "markerfacecolor"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1607 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1608 @w{line markerfacecolor property}}.";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1609
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1610 case "markersize"
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	1611 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	1612 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1613
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1614 case "specularcolorreflectance"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1615 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	1616 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	1617 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1618
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1619 case "specularexponent"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1620 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	1621 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	1622 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1623
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1624 case "specularstrength"
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1625 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	1626 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	1627 s.valid = "scalar";
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1628
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1629 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	1630 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	1631 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	1632 @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	1633
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1634 case "vertexnormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951). Markus Mützel <markus.muetzel@gmx.de> parents: 25465 diff changeset	1635 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	1636 @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	1637 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	1638 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	1639
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1640 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1641 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1642
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1643 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1644 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1645
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1646 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1647 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1648
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1649 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1650 s.valid = valid_vecmat;
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	1651
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	1652 endswitch
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1653
28286 496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1654 ## Scatter properties
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1655 elseif (strcmp (objname, "scatter"))
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1656 switch (field)
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1657 ## Overridden shared properties
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1658 case "children"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1659 s.doc = doc_unused;
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1660
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1661 ## Specific properties
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1662 case "cdatamode"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1663 s.doc = "If @code{cdatamode} is @qcode{\"auto\"}, @code{cdata} is set \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1664 to the color from the @code{colororder} of the ancestor axes corresponding to \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1665 the @code{seriesindex}.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1666
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1667 case "cdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1668 s.doc = sprintf (doc_notimpl, "Data from workspace variables");
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1669
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1670 case "cdata"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1671 s.doc = "Data defining the scatter object color.\n\
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1672 \n\
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1673 If @code{cdata} is a scalar index into the current colormap or a RGB triplet, \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1674 it defines the color of all scatter markers.\n\
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1675 \n\
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1676 If @code{cdata} is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1677 it defines the color of each one of the N scatter markers.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1678 s.valid = valid_scalmat;
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1679
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1680
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1681 case "displayname"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1682 s.doc = "Text of the legend entry corresponding to this scatter object.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1683
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1684 case "linewidth"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1685 s.doc = "Line width of the edge of the markers.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1686
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1687 case "marker"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1688 s.doc = "@xref{XREFlinemarker, , @w{line marker property}}.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1689
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1690 case "markeredgealpha"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1691 s.doc = "Transparency level of the faces of the markers where a \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1692 value of 0 means complete transparency and a value of 1 means solid faces \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1693 without transparency. Note that the markers are not sorted from back to \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1694 front which might lead to unexpected results when rendering layered \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1695 transparent markers or in combination with other transparent objects.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1696 s.valid = "scalar";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1697
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1698 case "markeredgecolor"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1699 s.doc = "Color of the edge of the markers. @qcode{\"none\"} means \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1700 that the edges are transparent and @qcode{\"flat\"} means that the value \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1701 from @code{cdata} is used. @xref{XREFlinemarkeredgecolor, , \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1702 @w{line markeredgecolor property}}.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1703 s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1704 "@qcode{\"flat\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1705 valid_color});
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1706
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1707 case "markerfacealpha"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1708 s.doc = "Transparency level of the faces of the markers where a \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1709 value of 0 means complete transparency and a value of 1 means solid faces \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1710 without transparency. Note that the markers are not sorted from back to \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1711 front which might lead to unexpected results when rendering layered \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1712 transparent markers or in combination with other transparent objects.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1713 s.valid = "scalar";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1714
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1715 case "markerfacecolor"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1716 s.doc = "Color of the face of the markers. @qcode{\"none\"} means \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1717 that the faces are transparent, @qcode{\"flat\"} means that the value from \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1718 @code{cdata} is used, and @qcode{\"auto\"} uses the @code{color} property of \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1719 the ancestor axes. @xref{XREFlinemarkerfacecolor, , \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1720 @w{line markerfacecolor property}}.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1721 s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1722 "@qcode{\"flat\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1723 "@qcode{\"auto\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1724 valid_color});
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1725
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1726 case "seriesindex"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1727 s.doc = "Each scatter object in the same axes is asigned an \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1728 incrementing integer. This corresponds to the index into the \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1729 @code{colororder} of the ancestor axes that is used if @code{cdatamode} is \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1730 set to @qcode{\"auto\"}.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1731
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1732 case "sizedatasource"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1733 s.doc = sprintf (doc_notimpl, "Data from workspace variables");
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1734
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1735 case "sizedata"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1736 s.doc = "Size of the area of the marker. A scalar value applies to \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1737 all markers. If @code{cdata} is an N-by-1 vector, it defines the color of \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1738 each one of the N scatter markers.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1739 s.valid = packopt ({"[]", "scalar", "vector"});
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1740
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1741 case "xdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1742 s.doc = sprintf (doc_notimpl, "Data from workspace variables");
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1743
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1744 case "xdata"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1745 s.doc = "Vector with the x coordinates of the scatter object.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1746 s.valid = "vector";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1747
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1748 case "ydatasource"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1749 s.doc = sprintf (doc_notimpl, "Data from workspace variables");
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1750
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1751 case "ydata"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1752 s.doc = "Vector with the y coordinates of the scatter object.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1753 s.valid = "vector";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1754
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1755 case "zdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1756 s.doc = sprintf (doc_notimpl, "Data from workspace variables");
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1757
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1758 case "zdata"
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1759 s.doc = "For 3D data, vector with the y coordinates of the scatter \
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1760 object.";
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1761 s.valid = packopt ({"[]", "vector"});
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1762
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1763 endswitch
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	1764
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1765 ## Light properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1766 elseif (strcmp (objname, "light"))
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1767 switch (field)
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1768 ## Overridden shared properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1769 case "children"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1770 s.doc = doc_unused;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1771
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1772 ## Specific properties
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1773 case "color"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1774 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	1775 s.valid = valid_color;
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1776
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1777 case "position"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1778 s.doc = "Position of the light source.";
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1779
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1780 case "style"
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1781 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	1782 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	1783 point source (@qcode{\"local\"}).";
21789 6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1784
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1785 endswitch
6afdf40be534 Implement graphics object "light" (patch #8943). mmuetzel <markus.muetzel@gmx.de> parents: 21530 diff changeset	1786
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1787 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1788 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	1789 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1790 ## 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	1791 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1792 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	1793
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1794 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1795 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1796 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1797 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1798 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1799 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1800 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1801 case "position"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1802 case "separator"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1803
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1804 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1805
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1806 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1807 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	1808 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1809 ## 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	1810 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1811 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	1812
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1813 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1814 case "callback"
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1815 case "position"
5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20593 diff changeset	1816
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1817 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1818
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1819 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1820 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	1821 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1822 ## 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	1823
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1824 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1825 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1826 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1827 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1828 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1829 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1830
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1831 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1832 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	1833 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	1834
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1835 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1836 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	1837 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1838
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1839 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1840 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	1841
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1842 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1843 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1844
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1845 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1846 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1847 case "position"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1848
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1849 case "resizefcn"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1850 s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1851 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1852
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1853 case "shadowcolor"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1854
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1855 case "sizechangedfcn"
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1856 s.doc = "Callback triggered when the uipanel size is changed.\
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1857 \n\n__fcnmsg__";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1858 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1859
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1860 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1861 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1862 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1863
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1864 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1865
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1866 ## uibuttongroup properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1867 elseif (strcmp (objname, "uibuttongroup"))
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1868 switch (field)
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1869 ## Overridden shared properties
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1870
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1871 ## Specific properties
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1872 case "backgroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1873 case "bordertype"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1874 case "borderwidth"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1875 case "fontangle"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1876 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1877
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1878 case "fontname"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1879 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	1880 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	1881
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1882 case "fontsize"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1883 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	1884 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1885
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1886 case "fontunits"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1887 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	1888
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1889 case "fontweight"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1890 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1891
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1892 case "foregroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1893 case "highlightcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1894 case "position"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1895
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1896 case "resizefcn"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1897 s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1898 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1899
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1900 case "selectedobject"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1901 case "selectionchangedfcn"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1902 case "shadowcolor"
26195 a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1903
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1904 case "sizechangedfcn"
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1905 s.doc = "Callback triggered when the uibuttongroup size is changed.\
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1906 \n\n__fcnmsg__";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1907 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085). Rik <rik@octave.org> parents: 26122 diff changeset	1908
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1909 case "title"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1910 case "titleposition"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1911 case "units"
21824 6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1912
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1913 endswitch
6780a8657be3 Implement uibuttongroup (bug #47513) Andrew Thornton <art27@cantab.net> parents: 21789 diff changeset	1914
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1915 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1916 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	1917 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1918 ## 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	1919
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1920 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1921 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1922 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1923 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1924 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1925 case "extent"
27254 e3d886685813 Let graphics toolkit compute the extent of uicontrol text strings (bug #48446) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27140 diff changeset	1926 s.doc = "Size of the text string associated to the uicontrol \
e3d886685813 Let graphics toolkit compute the extent of uicontrol text strings (bug #48446) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27140 diff changeset	1927 returned in the form @code{[0 0 width height]} (the two first elements \
e3d886685813 Let graphics toolkit compute the extent of uicontrol text strings (bug #48446) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27140 diff changeset	1928 are always zero).\n\n\
e3d886685813 Let graphics toolkit compute the extent of uicontrol text strings (bug #48446) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27140 diff changeset	1929 For multi-line strings the returned @code{width} and @code{height} \
e3d886685813 Let graphics toolkit compute the extent of uicontrol text strings (bug #48446) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 27140 diff changeset	1930 indicate the size of the rectangle enclosing all lines.";
25783 e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1931 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	1932 s.printdefault = false;
e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505). Rik <rik@octave.org> parents: 25054 diff changeset	1933
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1934 case "fontangle"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1935 s.doc = doc_fontangle;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1936
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1937 case "fontname"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1938 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	1939 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	1940
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1941 case "fontsize"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1942 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	1943 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1944
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1945 case "fontunits"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1946 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	1947
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1948 case "fontweight"
23210 3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353). Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 23208 diff changeset	1949 s.doc = doc_fontweight;
23396 945b53af4655 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 23395 diff changeset	1950
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1951 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1952 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1953 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1954 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1955 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1956 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1957 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1958 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1959 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1960 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1961 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1962 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1963 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1964 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1965
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1966 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	1967
26112 36e0e5b428e7 Implement uitable (patch #9084) Andrew Thornton <art27@cantab.net> parents: 25998 diff changeset	1968 ## uitable Properties
36e0e5b428e7 Implement uitable (patch #9084) Andrew Thornton <art27@cantab.net> parents: 25998 diff changeset	1969 elseif (strcmp (objname, "uitable"))
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1970 switch (field)
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1971 ## Overridden shared properties
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1972
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1973 ## Specific properties
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1974 case "backgroundcolor"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1975 case "celleditcallback"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1976 case "cellselectioncallback"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1977 case "columneditable"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1978 case "columnformat"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1979 case "columnname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1980 case "columnwidth"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1981 case "data"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1982 case "enable"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1983 case "extent"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1984 s.valid = valid_4elvec;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1985 s.printdefault = false;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1986
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1987 case "fontangle"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1988 s.doc = doc_fontangle;
26112 36e0e5b428e7 Implement uitable (patch #9084) Andrew Thornton <art27@cantab.net> parents: 25998 diff changeset	1989
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1990 case "fontname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1991 s.doc = doc_fontname;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1992 s.valid = valid_string;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1993
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1994 case "fontsize"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1995 s.doc = doc_fontsize;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1996 s.valid = "scalar";
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1997
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1998 case "fontunits"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	1999 s.doc = doc_fontunits;
26112 36e0e5b428e7 Implement uitable (patch #9084) Andrew Thornton <art27@cantab.net> parents: 25998 diff changeset	2000
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2001 case "fontweight"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2002 s.doc = doc_fontweight;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2003
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2004 case "foregroundcolor"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2005 case "keypressfcn"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2006 case "keyreleasefcn"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2007 case "position"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2008 case "rearrangeablecolumns"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2009 case "rowname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2010 case "rowstriping"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2011 case "tooltipstring"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2012 case "units"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2013
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2014 endswitch
26112 36e0e5b428e7 Implement uitable (patch #9084) Andrew Thornton <art27@cantab.net> parents: 25998 diff changeset	2015
20593 3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2016 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2017 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	2018 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2019 ## 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	2020 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2021 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	2022
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2023 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2024
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2025 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2026 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	2027 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2028 ## 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	2029 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2030 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	2031
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2032 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2033 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2034 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2035 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2036 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2037 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2038
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2039 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2040
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2041 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2042 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	2043 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2044 ## 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	2045 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2046 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	2047
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2048 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2049 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2050 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2051 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2052 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2053 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2054 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2055 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2056 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2057
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20478 diff changeset	2058 endswitch
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2059 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2060
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2061 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2062 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2063 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	2064 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2065
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2066 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2067
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2068 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2069 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2070 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2071
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2072 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	2073 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2074 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2075 strout = strrep (strout, "__modemsg__", modemsg);
23205 1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	2076 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	2077 functions see @ref{Callbacks, , @w{Callbacks section}}.";
1468c2234478 Better documentation of fcn properties Pantxo Diribarne <pantxo.diribarne@gmail.com>* parents: 23202 diff changeset	2078 strout = strrep (strout, "__fcnmsg__", fcnmsg);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2079 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2080
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2081 function s = getstructure (objname, base = [], props = {})
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2082 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2083 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	2084 ## 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	2085 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2086 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2087
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2088 ## 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	2089 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	2090 ## 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	2091 ## regular (non-hidden) property, "displayname".
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2092 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2093 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2094 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2095 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2096 h = hf;
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2097 elseif (strcmp (objname, "legend"))
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2098 line ();
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2099 h = legend ();
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2100 if (isempty (props))
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2101 props = {"autoupdate", "box", "color", "edgecolor", "fontangle", ...
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2102 "fontname", "fontsize", "fontunits", "fontweight", ...
30622 18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	2103 "itemhitfcn", "location", "numcolumns", "orientation", ...
18a9b3c7b63b legend.m: Implement "itemhitfcn" property Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 30564 diff changeset	2104 "position", "string", "textcolor", "title", "units"};
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2105 endif
28286 496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	2106 elseif (strcmp (objname, "scatter"))
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	2107 ## Make sure to get a scatter object independent of graphics toolkit
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	2108 hax = axes (hf);
496735a910c1 Add graphics object "scatter" (bug #58282). Markus Mützel <markus.muetzel@gmx.de> parents: 27957 diff changeset	2109 h = __go_scatter__ (hax);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2110 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2111 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2112 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2113
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2114 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2115 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2116
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2117 if (! isempty (props))
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2118 flds = fieldnames (gprop);
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2119 idx = cellfun (@(s) ! any (strcmp (props, s)), flds);
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2120 gprop = rmfield (gprop, flds(idx));
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2121 flds = fieldnames (sprop);
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2122 idx = cellfun (@(s) ! any (strcmp (props, s)), flds);
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2123 sprop = rmfield (sprop, flds(idx));
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2124 endif
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2125
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2126 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2127 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2128 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2129 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2130 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2131
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2132 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2133 val = getdoc (objname, field, base);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2134
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2135 ## 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	2136 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2137 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2138 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2139
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2140 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2141
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2142 ## 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	2143 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2144 val.valid = sprop.(field);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2145 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	2146 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2147 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	2148 "uniformoutput", false);
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2149 val.valid = strjoin (val.valid, " \| ");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2150 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2151 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2152
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2153 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2154 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2155 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2156
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2157 ## 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	2158 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2159
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2160 if (strcmp (objname, "base"))
21931 ffa911b616c7 * genpropdoc.m: Don't handle erasemode property. John W. Eaton <jwe@octave.org> parents: 21824 diff changeset	2161 s = rmfield (s, "displayname");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2162 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2163
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2164 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2165 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2166 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2167
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2168 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2169
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2170 function def = getdefault (h, objname, field)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2171 ## 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	2172 ## 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	2173 def = get (h, field);
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2174
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2175 ## 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	2176 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	2177 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2178 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2179 if (ischar (def))
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2180 def = ['@qcode{"' def '"}'];
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2181 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2182 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	2183 ## 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	2184 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2185 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2186 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2187 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2188
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2189 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2190 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2191 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2192 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2193 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2194 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2195 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2196 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2197
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2198 ## Replace texinfo reserved characters
26122 4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2199 def = strrep (str, "@", "@@"); # must occur first
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7. Rik <rik@octave.org> parents: 26112 diff changeset	2200 def = strrep (def, "{", "@{");
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2201 def = strrep (def, "}", "@}");
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2202
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2203 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2204 else
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2205 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	2206 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2207 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2208 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2209 endif
19824 0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties. Rik <rik@octave.org> parents: 19792 diff changeset	2210
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2211 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2212
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2213 function str = printdoc (objname, obj, is_prop_subset)
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2214 ## 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	2215 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2216 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2217
26877 83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2218 ## File header and beginning of properties table
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2219 str = warn_autogen ();
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2220 if (strcmp (objname, "root"))
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2221 str = sprintf ("%s\n\nProperties of the root graphics object:", str);
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2222 elseif (is_prop_subset)
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2223 ## Do nothing
26877 83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2224 else
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2225 str = sprintf ("%s\n\nProperties of @code{%s} objects (@pxref{XREF%s,,%s}):",
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2226 str, objname, objname, objname);
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2227 endif
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076). Rik <rik@octave.org> parents: 26376 diff changeset	2228 str = sprintf ("%s\n\n@table @asis", str);
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2229
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2230 for ii = 1:nf
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2231 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2232 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2233
28658 c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2234 if (! is_prop_subset)
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2235 ## @anchor: cross reference using XREFobjnamefield label
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2236 ## Concept index: call info from octave with 'doc ("objname field")'
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2237 str = sprintf ("%s@anchor{XREF%s%s}\n@prindex %s %s\n",
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2238 str, objname, field, objname, field);
c49a546a745a Better documentation for legend objects (bug #57254) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 28393 diff changeset	2239 endif
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2240
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2241 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2242 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	2243
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2244 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2245 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2246 str = sprintf ("%s (read-only):", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2247 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2248 str = sprintf ("%s:", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2249 endif
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2250
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2251 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2252 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2253 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2254 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2255 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2256 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2257 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2258 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2259
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2260 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2261 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	2262 endfor
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19407 diff changeset	2263
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2264 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2265 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	2266
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2267 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2268
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2269 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2270 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	2271 \n\
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	2272 @c Copyright (C) 2014-2022 The Octave Project Developers\n\
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2273 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2274 @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	2275 @c\n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	2276 @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	2277 @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	2278 @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	2279 @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	2280 @c\n\
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24523 diff changeset	2281 @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	2282 @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	2283 @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	2284 @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	2285 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2286 @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	2287 @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	2288 @c <https://www.gnu.org/licenses/>.";
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2289 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2290
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2291 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2292 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2293 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2294 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2295 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2296 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2297 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2298 str = tmp;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2299 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2300 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2301 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2302 endif
20258 530803d4f65f Update root, figure, and axes graphics object properties. Rik <rik@octave.org> parents: 20101 diff changeset	2303
19257 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: diff changeset	2304 endfunction