Mercurial > octave

annotate doc/interpreter/genpropdoc.m @ 28303:af912e78ce43

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336). * graphics.in.h (axes::properties): Hide property "activepositionproperty". (axes::properties::get_activepositionproperty, axes::properties::set_activepositionproperty): Add functions that redirect to "positionconstraint" property and translate values. * graphics.cc (axes::properties): Replace setting "activepositionproperty" by setting "positionconstraint". * doc/interpreter/genpropdoc.m: Move description from "activepositionproperty" axes property to "positionconstraint".
author Markus Mützel <markus.muetzel@gmx.de>
date Sun, 17 May 2020 20:49:02 +0200
parents 1f5ec8c025bc
children 4ea54a38c500
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 2014-2020 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
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
40 function genpropdoc (objname, fname)
26122
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
41 objnames = {"root", "figure", "axes", ...
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)))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
53 obj = getstructure (objname, base);
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
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
59 str = printdoc (objname, obj);
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
60
19792
4f6ae6b94abe make --enable-silent-rules configure option more useful
John W. Eaton <jwe@octave.org>
parents: 19776
diff changeset
61 if (nargin == 2)
4f6ae6b94abe make --enable-silent-rules configure option more useful
John W. Eaton <jwe@octave.org>
parents: 19776
diff changeset
62 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 \
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
128 default sans serif font (same as the default @qcode{\"*\"} value).";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
129 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
130 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
131 text rendering.";
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
132
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
133 ## Initialize structure
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
134 if (isfield (base, field))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
135 s = base.(field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
136 else
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
137 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
138 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
139
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
140 ## 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
141 ## 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
142 ## 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
143 ## to be rewritten for this object.
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
144 if (strcmp (objname, "base"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
145 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
146 case "beingdeleted"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
147 case "busyaction"
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24549
diff changeset
148 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
149 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
150 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
151 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
152 \@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
153 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
154 (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
155 @xref{Callbacks, , @w{Callbacks section}}.";
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24626
diff changeset
156
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
157 case "buttondownfcn"
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
158 s.doc = "__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
159 s.valid = valid_fcn;
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
160
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
161 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
162 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
163 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
164
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
165 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
166 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
167 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
168
28298
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28286
diff changeset
169 case "contextmenu"
e55ff14249c3 Mirror new base property "contextmenu" in "uicontextmenu" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28286
diff changeset
170 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
171 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
172 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
173
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
174 case "createfcn"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
175 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
176 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
177 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
178 'disp (\"__objname__ created!\")')}.\n\n__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
179 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
180
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
181 case "deletefcn"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
182 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
183 is deleted.\n\n__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
184 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
185
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
186 case "handlevisibility"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
187 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
188 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
189
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
190 case "hittest"
24523
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
191 s.doc = "Specify whether __objname__ processes mouse events \
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
192 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
193 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
194 the uicontextmenu, and eventually becoming the root \
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
195 @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
196 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
197 property. @xref{XREF__objname__pickableparts, , @w{pickableparts property}}.";
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
198
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
199 case "interruptible"
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24549
diff changeset
200 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
201 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
202 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
203 @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
204 @xref{Callbacks, , @w{Callbacks section}}.";
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24626
diff changeset
205
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
206 case "parent"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
207 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
208 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
209
24523
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
210 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
211 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
212 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
213 __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
214 @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
215 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
216 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
217 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
218 will determine how they are processed. \
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
219 @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
220
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
221 case "selected"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
222 case "selectionhighlight"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
223 case "tag"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
224 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
225 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
226
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
227 case "type"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
228 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
229 always @qcode{\"__objname__\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
230 s.valid = valid_string;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
231 s.printdefault = false;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
232
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
233 case "userdata"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
234 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
235 s.valid = "Any Octave data";
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
236
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
237 case "visible"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
238 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
239 not rendered on screen.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
240 endswitch
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
241
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
242 ## Root properties:
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
243 elseif (strcmp (objname, "root"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
244 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
245 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
246 case {"beingdeleted", "busyaction", "buttondownfcn", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
247 "clipping", "createfcn", "deletefcn", "handlevisibility", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
248 "hittest", "interruptible", "selected", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
249 "selectionhighlight", "uicontextmenu", "visible"}
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
250 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
251
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
252 case "parent"
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
253 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
254 is always empty.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
255
24523
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
256 case "hittest"
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
257 s.doc = doc_unused;
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24626
diff changeset
258
24523
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
259 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
260 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
261
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
262 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
263 case "callbackobject"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
264 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
265 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
266
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
267 case "currentfigure"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
268 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
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 "diary"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
272 s.doc = "If __prop__ is @qcode{\"on\"}, the Octave command window \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
273 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
274
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
275 case "diaryfile"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
276 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
277 @xref{XREFdiary, , @w{diary function}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
278 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
279
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
280 case "echo"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
281 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
282 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
283
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
284 case "errormessage"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
285 s.doc = "The last error message raised. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
286 @xref{XREFlasterr, , @w{lasterr function}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
287 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
288
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
289 case "fixedwidthfontname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
290 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
291
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
292 case "format"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
293 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
294 @xref{XREFformat, , @w{format function}}.";
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 "formatspacing"
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 "language"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
301 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
302
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
303 case "monitorpositions"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
304 s.doc = doc_unused;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
305 s.printdefault = false;
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 "pointerlocation"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
308 s.doc = doc_unused;
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
309 s.valid = valid_2elvec;
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 "pointerwindow"
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_handle;
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 "recursionlimit"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
316 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
317 recursively. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
318 @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
319 s.valid = "double";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
320
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
321 case "screendepth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
322 s.valid = "double";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
323 s.printdefault = false;
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 "screenpixelsperinch"
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 "screensize"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
330 s.valid = valid_4elvec;
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 "showhiddenhandles"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
334 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
335 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
336 @code{handlevisibility} property.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
337
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
338 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
339 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
340
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
341 ## Figure properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
342 elseif (strcmp (objname, "figure"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
343 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
344 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
345 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
346 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
347
24523
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
348 case "pickableparts"
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
349 s.doc = doc_unused;
501986e12b8b Implement "pickableparts" property (bug #52795).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24462
diff changeset
350
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
351 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
352 case "alphamap"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
353 s.doc = sprintf (doc_notimpl, "Transparency");
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
354
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
355 case "closerequestfcn"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
356 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
357 @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
358 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
359
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
360 case "color"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
361 s.doc = "Color of the figure background. \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
362 @xref{Colors, , colorspec}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
363 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
364
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
365 case "colormap"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
366 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
367 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
368
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
369 case "currentaxes"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
370 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
371 s.valid = valid_handle;
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 "currentcharacter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
374 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
375
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
376 case "currentobject"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
377 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
378
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
379 case "currentpoint"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
380 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
381 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
382 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
383 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
384 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
385 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
386 @table @asis\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
387 @item A mouse button was pressed\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
388 always\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
389 @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
390 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
391 @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
392 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
393 @end table";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
394 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
395
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
396 case "dockcontrols"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
397 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
398
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
399 case "filename"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
400 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
401 s.valid = valid_string;
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
402
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
403 case "graphicssmoothing"
21948
241d39c66e8f Update graphics properties for figure object.
Rik <rik@octave.org>
parents: 21931
diff changeset
404 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
405
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
406 case "integerhandle"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
407 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
408
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
409 case "inverthardcopy"
21948
241d39c66e8f Update graphics properties for figure object.
Rik <rik@octave.org>
parents: 21931
diff changeset
410 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
411
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
412 case "keypressfcn"
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
413 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
414 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
415 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
416 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
417
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
418 case "keyreleasefcn"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
419 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
420 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
421 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
422 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
423 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
424 @table @code\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
425 @item Character:\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
426 The ASCII value of the key\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
427 @item Key:\n\
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
428 Lowercase value of the key\n\
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
429 @item Modifier:\n\
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
430 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
431 key.\n\
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
432 @end table\
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
433 \n\n__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
434 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
435
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
436 case "menubar"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
437 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
438 of the figure.";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
439
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
440 case "name"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
441 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
442 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
443 property.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
444 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
445
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
446 ## 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
447 #case "number"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
448 # s.doc = "Number of current figure (RO).";
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
449
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
450 case "nextplot"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
451 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
452 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
453 @xref{XREFnewplot, , @w{newplot function}}.";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
454
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
455 case "numbertitle"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
456 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
457 value in the figure title bar.";
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 "outerposition"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
460 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
461 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
462 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
463 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
464 @xref{XREFfigureunits, , @w{units property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
465 s.valid = valid_4elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
466
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
467 case "paperorientation"
20930
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties.
Ben Abbott <bpabbott@mac.com>
parents: 20905
diff changeset
468 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
469 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
470 @code{papersize} and @code{paperposition} reverse order \
21948
241d39c66e8f Update graphics properties for figure object.
Rik <rik@octave.org>
parents: 21931
diff changeset
471 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
472 @code{\"landscape\"}.";
20886
3c986b688596 Improve the documentation for the figure paper properties.
Ben Abbott <bpabbott@mac.com>
parents: 20715
diff changeset
473
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
474 case "paperposition"
20930
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties.
Ben Abbott <bpabbott@mac.com>
parents: 20905
diff changeset
475 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
476 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
477 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
478 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
479 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
480 @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
481 ignored. \
20930
b6ea72a439f8 genpropdoc.m: Add features unique to Octave for the paper* properties.
Ben Abbott <bpabbott@mac.com>
parents: 20905
diff changeset
482 __modemsg__.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
483 s.valid = valid_4elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
484
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
485 case "paperpositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
486 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
487 @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
488 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
489 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
490 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
491
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
492 case "papersize"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
493 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
494 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
495 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
496 @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
497 @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
498 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
499 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
500 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
501
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
502 case "papertype"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
503 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
504 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
505 with the @code{paperorientation} property.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
506
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
507 case "paperunits"
20886
3c986b688596 Improve the documentation for the figure paper properties.
Ben Abbott <bpabbott@mac.com>
parents: 20715
diff changeset
508 s.doc = "The unit used to compute the @code{paperposition} property. \
3c986b688596 Improve the documentation for the figure paper properties.
Ben Abbott <bpabbott@mac.com>
parents: 20715
diff changeset
509 For __prop__ set to @code{\"pixels\"}, the conversion between physical \
3c986b688596 Improve the documentation for the figure paper properties.
Ben Abbott <bpabbott@mac.com>
parents: 20715
diff changeset
510 units (ex: @code{\"inches\"}) and @code{\"pixels\"} is dependent on the \
3c986b688596 Improve the documentation for the figure paper properties.
Ben Abbott <bpabbott@mac.com>
parents: 20715
diff changeset
511 @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
512
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
513 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
514 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
515 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
516 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
517 __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
518 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
519 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
520
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
521 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
522 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
523 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
524 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
525 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
526 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
527
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
528 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
529 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
530 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
531 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
532
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
533 case "position"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
534 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
535 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
536 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
537 @xref{XREFfigureunits, , @w{units property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
538 s.valid = valid_4elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
539
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
540 case "renderer"
27956
2310164737b3 fix many spelling errors (bug #57613)
John W. Eaton <jwe@octave.org>
parents: 27088
diff changeset
541 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
542 is \"manual\". __modemsg__.";
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
543
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
544 case "renderermode"
27956
2310164737b3 fix many spelling errors (bug #57613)
John W. Eaton <jwe@octave.org>
parents: 27088
diff changeset
545 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
546 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
547 @xref{XREFprint, , @w{print function}}.";
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
548
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
549 case "resize"
25929
ea5182364e5f Implement "resize" property for Qt figures (bug #54774)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25867
diff changeset
550 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
551 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
552 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
553 changing its @qcode{\"position\"} property.";
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
554
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
555 case "resizefcn"
22506
84bd1f3c3ee1 genpropdoc.m: Add semicolons to EOL to prevent script variables entering documentation
Rik <rik@octave.org>
parents: 22323
diff changeset
556 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
557 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
558
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
559 case "selectiontype"
27135
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
560 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
561 __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
562 button and keyboard modifier that were used:\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
563 @table @code\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
564 @item normal:\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
565 Left-click.\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
566 @item alt:\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
567 Right-click or Ctrl+Left-click.\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
568 @item extend:\n\
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
569 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
570 @item open:\n\
27140
142084841f23 doc: Silence two TexInfo warnings.
Rik <rik@octave.org>
parents: 27135
diff changeset
571 Double Left-click.\n\
27135
bf2f533d2d45 Document the figure "selectiontype" property
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27125
diff changeset
572 @end table";
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
573
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
574 case "sizechangedfcn"
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
575 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
576 \n\n__fcnmsg__";
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
577 s.valid = valid_fcn;
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
578
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
579 case "toolbar"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
580 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
581 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
582
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
583 case "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
584 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
585 @code{outerposition} properties.";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
586
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
587 case "windowbuttondownfcn"
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
588 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
589 @w{windowbuttonupfcn property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
590 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
591
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
592 case "windowbuttonmotionfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
593 s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
594 @w{windowbuttonupfcn property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
595 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
596
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
597 case "windowbuttonupfcn"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
598 s.doc = "With @code{windowbuttondownfcn} and \
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
599 @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
600 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
601 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
602 @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
603 \n\n__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
604 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
605
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
606 case "windowkeypressfcn"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
607 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
608 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
609 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
610
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
611 case "windowkeyreleasefcn"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
612 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
613 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
614 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
615
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
616 case "windowscrollwheelfcn"
27125
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27099
diff changeset
617 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
618 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
619 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
620 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
621 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
622 @table @code\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27099
diff changeset
623 @item VerticalScrollCount:\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27099
diff changeset
624 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
625 scrolling up.\n\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27099
diff changeset
626 @item VerticalScrollAmount:\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 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
628 @item EventName:\n\
27140
142084841f23 doc: Silence two TexInfo warnings.
Rik <rik@octave.org>
parents: 27135
diff changeset
629 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
630 @end table\
d2d2f66e1cdc Implement figure "windowscrollwheelfcn" property for Qt toolkit (bug #56028).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27099
diff changeset
631 \n\n__fcnmsg__";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
632 s.valid = valid_fcn;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
633
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
634 case "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
635 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
636 @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
637 @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
638 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
639 @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
640 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
641 @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
642 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
643 @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
644 \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 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
646
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
647 endswitch
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
648
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
649 ## Axes properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
650 elseif (strcmp (objname, "axes"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
651 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
652 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
653 case "clipping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
654 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
655
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
656 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
657 case "alim"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
658 s.doc = sprintf (doc_notimpl, "Transparency");
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
659
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
660 case "alimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
661 case "ambientlightcolor"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
662 s.doc = doc_unused;
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
663
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
664 case "box"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
665 s.doc = "Control whether the axes has a surrounding box.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
666
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
667 case "boxstyle"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
668 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
669 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
670
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
671 case "cameraposition"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
672 s.valid = valid_3elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
673
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
674 case "camerapositionmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
675 case "cameratarget"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
676 s.valid = valid_3elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
677
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
678 case "cameratargetmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
679 case "cameraupvector"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
680 s.valid = valid_3elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
681
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
682 case "cameraupvectormode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
683 case "cameraviewangle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
684 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
685
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
686 case "cameraviewanglemode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
687 case "clim"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
688 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
689 __modemsg__. @xref{XREFpcolor, , @w{pcolor function}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
690 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
691
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
692 case "climmode"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
693
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
694 case "clippingstyle"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
695 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
696
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
697 case "color"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
698 s.doc = "Color of the axes background. @xref{Colors, , colorspec}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
699 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
700
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
701 case "colororder"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
702 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
703 coloring.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
704 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
705
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
706 case "colororderindex"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
707 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
708
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
709 case "currentpoint"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
710 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
711 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
712 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
713 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
714 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
715 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
716 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
717 perpendicular to the screen.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
718 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
719
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
720 case "dataaspectratio"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
721 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
722 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
723 @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
724 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
725 @xref{XREFdaspect, , daspect function}. __modemsg__.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
726 s.valid = valid_3elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
727
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
728 case "dataaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
729 case "fontangle"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
730 s.doc = doc_fontangle;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
731
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
732 case "fontname"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
733 s.doc = doc_fontname;
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
734 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
735
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
736 case "fontsize"
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_fontsize;
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
738 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
739
26858
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 26376
diff changeset
740 case "fontsmoothing"
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 26376
diff changeset
741 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
742
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
743 case "fontunits"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
744 s.doc = doc_fontunits;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
745
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
746 case "fontweight"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
747 s.doc = doc_fontweight;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
748
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
749 case "gridalpha"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
750 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
751
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
752 case "gridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
753 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
754
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
755 case "gridcolor"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
756 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
757
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
758 case "gridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
759 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
760
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
761 case "gridlinestyle"
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
762
28302
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28298
diff changeset
763 case "innerposition"
1f5ec8c025bc Mirror value of axes property "innerposition" from "position" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28298
diff changeset
764 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
765 @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
766 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
767
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
768 case "labelfontsizemultiplier"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
769 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
770 label fontsize";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
771
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
772 case "layer"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
773 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
774 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
775
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
776 case "linestyleorder"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
777 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
778
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
779 case "linestyleorderindex"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
780 s.doc = doc_unused;
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
781
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
782 case "linewidth"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
783 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
784
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
785 case "minorgridalpha"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
786 s.doc = sprintf (doc_notimpl, "Transparency");
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
787
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
788 case "minorgridalphamode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
789 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
790
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
791 case "minorgridcolor"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
792 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
793
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
794 case "minorgridcolormode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
795 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
796
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
797 case "minorgridlinestyle"
19776
4cecd33915ef genpropdoc.m: Update axes property name to "mousewheelzoom".
Rik <rik@octave.org>
parents: 19746
diff changeset
798 case "mousewheelzoom"
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
799 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
800 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
801
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
802 case "nextplot"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
803 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
804 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
805 @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
806 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
807 @xref{XREFhold, , @w{hold function}}.";
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
808
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
809 case "outerposition"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
810 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
811 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
812 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
813 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
814 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
815 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
816 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
817 @xref{XREFaxesposition, , @w{position property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
818 s.valid = valid_4elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
819
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
820 case "plotboxaspectratio"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
821 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
822 __modemsg__.";
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
823
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
824 case "plotboxaspectratiomode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
825 case "position"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
826 s.doc = "Specify the position of the plot excluding titles, \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
827 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
828 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
829 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
830 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
831 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
832 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
833 @xref{XREFaxesouterposition, , @w{outerposition property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
834 s.valid = valid_4elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
835
28303
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28302
diff changeset
836 case "positionconstraint"
af912e78ce43 Mirror value of axes property "activepositionproperty" from "positionconstraint" (bug #58336).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28302
diff changeset
837 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
838 @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
839 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
840 @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
841 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
842
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
843 case "projection"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
844 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
845
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
846 case "sortmethod"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
847 s.doc = doc_unused;
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
848
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
849 case "tickdir"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
850 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
851 box or \"out\". __modemsg__.";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
852
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
853 case "tickdirmode"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
854
20285
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20258
diff changeset
855 case "ticklabelinterpreter"
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20258
diff changeset
856 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
857 @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
858
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
859 case "ticklength"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
860 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
861 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
862 s.valid = valid_2elvec;
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 "tightinset"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
865 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
866 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
867 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
868 s.printdefault = false;
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
869
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
870 case "title"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
871 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
872 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
873
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
874 case "titlefontsizemultiplier"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
875 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
876 label fontsize";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
877 s.valid = "positive scalar";
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
878
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
879 case "titlefontweight"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
880 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
881
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
882 case "units"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
883 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
884 @qcode{\"outerposition\"}, and @qcode{\"tightinset\"} properties.";
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
885
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
886 case "view"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
887 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
888 the viewpoint for three-dimensional plots";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
889 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
890
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
891 case "xaxislocation"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
892 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
893
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
894 case "xcolor"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
895 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
896 __modemsg__.";
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
897 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
898
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
899 case "xcolormode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
900
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
901 case "xdir"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
902 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
903 to right.";
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
904
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
905 case "xgrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
906 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
907
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
908 case "xlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
909 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
910 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
911
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
912 case "xlim"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
913 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
914 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
915 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
916
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
917 case "xlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
918 case "xminorgrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
919 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
920
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
921 case "xminortick"
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
922 case "xscale"
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
923 case "xtick"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
924 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
925 s.valid = "vector";
20463
ab4090316e6d Don't put default xtick vector size in documentation (bug #45725).
Rik <rik@octave.org>
parents: 20101
diff changeset
926 s.printdefault = false;
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 "xticklabel"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
929 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
930 s.valid = valid_cellstring;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
931
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
932 case "xticklabelmode"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
933 case "xticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
934 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
935
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
936 case "xtickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
937 case "yaxislocation"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
938 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
939
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
940 case "ycolor"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
941 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
942 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
943
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
944 case "ycolormode"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
945
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
946 case "ydir"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
947 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
948 to top.";
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
949
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
950 case "ygrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
951 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
952
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
953 case "ylabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
954 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
955 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
956
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
957 case "ylim"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
958 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
959 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
960 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
961
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
962 case "ylimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
963 case "yminorgrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
964 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
965
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
966 case "yminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
967 case "yscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
968 case "ytick"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
969 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
970 s.valid = "vector";
20463
ab4090316e6d Don't put default xtick vector size in documentation (bug #45725).
Rik <rik@octave.org>
parents: 20101
diff changeset
971 s.printdefault = false;
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 "yticklabel"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
974 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
975 s.valid = valid_cellstring;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
976
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
977 case "yticklabelmode"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
978 case "yticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
979 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
980
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
981 case "ytickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
982 case "zcolor"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
983 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
984 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
985
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
986 case "zcolormode"
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
987 case "zdir"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
988 case "zgrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
989 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
990
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
991 case "zlabel"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
992 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
993 s.valid = valid_handle;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
994
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
995 case "zlim"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
996 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
997 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
998 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
999
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1000 case "zlimmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1001 case "zminorgrid"
19746
97690ea6f57a Add documentation for axes property "mouse_wheel_zoom".
Rik <rik@octave.org>
parents: 19697
diff changeset
1002 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
1003
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1004 case "zminortick"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1005 case "zscale"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1006 case "ztick"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
1007 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
1008 s.valid = "vector";
20463
ab4090316e6d Don't put default xtick vector size in documentation (bug #45725).
Rik <rik@octave.org>
parents: 20101
diff changeset
1009 s.printdefault = false;
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 "zticklabel"
19407
86e69f51328d genpropdoc.m: Use two spaces after period at start of sentence.
Rik <rik@octave.org>
parents: 19325
diff changeset
1012 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
1013 s.valid = valid_cellstring;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1014
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1015 case "zticklabelmode"
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
1016 case "zticklabelrotation"
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
1017 s.doc = doc_unused;
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
1018
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1019 case "ztickmode"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1020 endswitch
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1021
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1022 ## Line properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1023 elseif (strcmp (objname, "line"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1024 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1025 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1026 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1027 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1028
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1029 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1030 case "color"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1031 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
1032 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1033
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1034 case "displayname"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1035 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
1036 s.valid = valid_cellstring;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1037
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1038 case "interpreter"
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1039
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1040 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1041 s.doc = "@xref{Line Styles}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1042
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1043 case "linewidth"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1044 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
1045
22759
39f39eb4e476 Implement "linejoin" property (bug #48387)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22755
diff changeset
1046 case "linejoin"
39f39eb4e476 Implement "linejoin" property (bug #48387)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22755
diff changeset
1047 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
1048 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
1049
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1050 case "marker"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1051 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
1052 @xref{Marker Styles}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1053
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1054 case "markeredgecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1055 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
1056 @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
1057 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
1058 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
1059
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1060 case "markerfacecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1061 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
1062 @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
1063 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
1064 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
1065
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1066 case "markersize"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1067 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
1068 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1069
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1070 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1071 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
1072 s.valid = "vector";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1073
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1074 case "xdatasource"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1075 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
1076 x data.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1077 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1078
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1079 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1080 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
1081 s.valid = "vector";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1082
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1083 case "ydatasource"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1084 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
1085 y data.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1086 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1087
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1088 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1089 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
1090 s.valid = "vector";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1091
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1092 case "zdatasource"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1093 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
1094 z data.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1095 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1096
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1097 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1098
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1099 ## Text properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1100 elseif (strcmp (objname, "text"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1101 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1102 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1103 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1104 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1105
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1106 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1107 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
1108 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
1109 @xref{Colors, , colorspec}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1110 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1111
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1112 case "color"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1113 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
1114 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1115
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1116 case "displayname"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1117 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
1118 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
1119 @xref{Colors, , colorspec}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1120 s.valid = valid_color;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1121
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1122 case "editing"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
1123 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1124
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1125 case "extent"
23202
c16e46aa3553 genpropdoc.m: document more graphics properties (bug #50337).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 22507
diff changeset
1126 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
1127 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
1128 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
1129 s.printdefault = false;
23394
7ca04e85f9e3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23219
diff changeset
1130
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1131 case "fontangle"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1132 s.doc = doc_fontangle;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1133
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1134 case "fontname"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1135 s.doc = doc_fontname;
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1136 s.valid = valid_string;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1137
26858
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 26376
diff changeset
1138 case "fontsmoothing"
0adb232f93b9 Implement axes and text "fontsmoothing" property (bug #55833).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 26376
diff changeset
1139 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
1140
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1141 case "fontsize"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1142 s.doc = doc_fontsize;
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1143 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1144
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1145 case "fontunits"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1146 s.doc = doc_fontunits;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1147
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1148 case "fontweight"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1149 s.doc = doc_fontweight;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1150
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1151 case "horizontalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1152 case "interpreter"
20285
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20258
diff changeset
1153 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
1154 interpreted.\n\
6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20258
diff changeset
1155 @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
1156
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1157 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
1158 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
1159
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1160 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
1161 s.doc = "Width of the outline.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1162 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1163
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1164 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
1165 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
1166 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
1167 of the @qcode{\"fontunits\"} property.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1168 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1169
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1170 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
1171 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
1172 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
1173 @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
1174 s.valid = valid_3elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1175
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1176 case "rotation"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1177 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
1178 measured in degrees.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1179 s.valid = "scalar";
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 "string"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1182 s.doc = "The text object string content.";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1183 s.valid = valid_string;
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 "units"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1186 case "verticalalignment"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1187 endswitch
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1188
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1189 ## Image properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1190 elseif (strcmp (objname, "image"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1191 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1192 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1193 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1194 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1195
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1196 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1197 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1198 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1199 s.valid = valid_scalmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1200
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1201 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1202 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
1203
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1204 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1205 s.valid = "matrix";
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 "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1208 case "displayname"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1209 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
1210 s.valid = valid_cellstring;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1211
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1212 case "xdata"
25980
221c039aa415 Fix rendering of images with permuted x/ydata (bug #49756).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25929
diff changeset
1213 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
1214 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
1215 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1216 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
1217 of @code{[1 columns(image)]}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1218 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1219
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1220 case "ydata"
25980
221c039aa415 Fix rendering of images with permuted x/ydata (bug #49756).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25929
diff changeset
1221 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
1222 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
1223 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1224 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
1225 of @code{[1 rows(image)]}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1226 s.valid = valid_2elvec;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1227
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1228 endswitch
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1229
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1230 ## Surface properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1231 elseif (strcmp (objname, "surface"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1232 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1233 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1234 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1235 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1236
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1237 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1238 case "alphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1239 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1240 s.valid = valid_scalmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1241
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1242 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1243 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
1244
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1245 case "ambientstrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1246 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
1247 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1248
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1249 case "backfacelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1250 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
1251 @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
1252 @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
1253
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1254 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1255 s.valid = "matrix";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1256
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1257 case "cdatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1258 case "cdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1259 case "diffusestrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1260 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
1261 diffuse reflex) and 1.0 (full diffuse reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1262 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1263
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1264 case "displayname"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1265 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
1266
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1267 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1268 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1269 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1270
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1271 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1272 case "edgelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1273 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
1274 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
1275 @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
1276 @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
1277 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
1278 @qcode{\"gouraud\"}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1279
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1280 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
1281 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
1282 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
1283 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
1284 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
1285 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
1286 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
1287 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
1288 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
1289 "@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
1290 "@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
1291 "@qcode{\"texturemap\"}"});
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1292
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1293 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1294 case "facelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1295 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
1296 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
1297 @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
1298 @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
1299 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
1300 @qcode{\"gouraud\"}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1301
25867
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1302 case "facenormals"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1303 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
1304 @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
1305 @qcode{\"flat\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1306
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1307 case "facenormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1308 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
1309 @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
1310 @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
1311 @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
1312
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1313 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1314 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1315 s.doc = "@xref{Line Styles}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1316
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1317 case "linewidth"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1318 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
1319
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1320 case "marker"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1321 s.doc = "@xref{Marker Styles}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1322
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1323 case "markeredgecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1324 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1325 @w{line markeredgecolor property}}.";
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 "markerfacecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1328 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1329 @w{line markerfacecolor property}}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1330
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1331 case "markersize"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1332 s.doc = "@xref{XREFlinemarkersize, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1333 @w{line markersize property}}.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1334 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1335
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1336 case "meshstyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1337 case "specularcolorreflectance"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1338 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
1339 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
1340 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1341
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1342 case "specularexponent"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1343 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
1344 the more the reflex is spread out.";
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1345 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1346
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1347 case "specularstrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1348 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
1349 specular reflex) and 1.0 (full specular reflex).";
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1350 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1351
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1352 case "vertexnormals"
25867
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1353 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
1354 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
1355 @qcode{\"gouraud\"}. __modemsg__";
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1356
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1357 case "vertexnormalsmode"
49ffa78f9243 Use "facenormals" for flat lighting on surfaces (bug #54024).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25861
diff changeset
1358 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
1359 @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
1360 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
1361 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
1362
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1363 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1364 s.valid = "matrix";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1365
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1366 case "xdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1367 case "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1368 s.valid = "matrix";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1369
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1370 case "ydatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1371 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1372 s.valid = "matrix";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1373
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1374 case "zdatasource"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1375 endswitch
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1376
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1377 ## Patch properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1378 elseif (strcmp (objname, "patch"))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1379 switch (field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1380 ## Overridden shared properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1381 case "children"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1382 s.doc = doc_unused;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1383
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1384 ## Specific properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1385 case "alphadatamapping"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1386 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
1387
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1388 case "ambientstrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1389 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
1390 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1391
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1392 case "backfacelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1393 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
1394 @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
1395 @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
1396
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1397 case "cdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1398 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
1399 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
1400 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1401 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
1402 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
1403 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1404 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
1405 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
1406 \n\
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1407 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
1408 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
1409 s.valid = valid_scalmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1410
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1411 case "diffusestrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1412 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
1413 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
1414 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1415
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1416 case "displayname"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1417 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
1418
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1419 case "edgealpha"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1420 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1421 s.valid = valid_scalmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1422
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1423 case "edgecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1424 case "edgelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1425 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
1426 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
1427 @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
1428 @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
1429 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
1430 @qcode{\"gouraud\"}.";
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 "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
1433 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
1434 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
1435 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
1436 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
1437 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
1438 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
1439 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
1440 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
1441 "@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
1442 "@qcode{\"interp\"}"});
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1443
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1444 case "facecolor"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1445 ## 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
1446 ## 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
1447 s.valid = packopt ({markdef(valid_color), ...
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1448 "@qcode{\"none\"}", ...
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1449 "@qcode{\"flat\"}", ...
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1450 "@qcode{\"interp\"}"});
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1451
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1452 case "facelighting"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1453 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
1454 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
1455 @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
1456 @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
1457 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
1458 @qcode{\"gouraud\"}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1459
25605
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1460 case "facenormals"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1461 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
1462 @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
1463 @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
1464
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1465 case "facenormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1466 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
1467 @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
1468 @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
1469 @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
1470
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1471 case "faces"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1472 s.valid = valid_vecmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1473
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1474 case "facevertexalphadata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1475 s.doc = sprintf (doc_notimpl, "Transparency");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1476 s.valid = valid_scalmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1477
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1478 case "facevertexcdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1479 case "interpreter"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1480 s.doc = doc_unused;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1481
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1482 case "linestyle"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1483 case "linewidth"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1484 case "marker"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1485 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
1486
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1487 case "markeredgecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1488 s.doc = "@xref{XREFlinemarkeredgecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1489 @w{line markeredgecolor property}}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1490
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1491 case "markerfacecolor"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1492 s.doc = "@xref{XREFlinemarkerfacecolor, , \
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1493 @w{line markerfacecolor property}}.";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1494
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1495 case "markersize"
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1496 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
1497 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1498
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1499 case "specularcolorreflectance"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1500 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
1501 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
1502 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1503
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1504 case "specularexponent"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1505 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
1506 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
1507 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1508
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1509 case "specularstrength"
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1510 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
1511 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
1512 s.valid = "scalar";
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1513
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1514 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
1515 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
1516 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
1517 @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
1518
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1519 case "vertexnormalsmode"
beef68dedef7 Document facenormals and vertexnormals properties of patch objects (patch #8951).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25465
diff changeset
1520 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
1521 @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
1522 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
1523 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
1524
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1525 case "vertices"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1526 s.valid = valid_vecmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1527
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1528 case "xdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1529 s.valid = valid_vecmat;
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 "ydata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1532 s.valid = valid_vecmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1533
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1534 case "zdata"
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1535 s.valid = valid_vecmat;
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1536
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1537 endswitch
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1538
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1539 ## Scatter properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1540 elseif (strcmp (objname, "scatter"))
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1541 switch (field)
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1542 ## Overridden shared properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1543 case "children"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1544 s.doc = doc_unused;
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1545
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1546 ## Specific properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1547 case "cdatamode"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1548 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
1549 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
1550 the @code{seriesindex}.";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1551
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1552 case "cdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1553 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
1554
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1555 case "cdata"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1556 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
1557 \n\
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1558 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
1559 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
1560 \n\
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1561 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
1562 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
1563 s.valid = valid_scalmat;
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1564
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1565
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1566 case "displayname"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1567 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
1568
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1569 case "linewidth"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1570 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
1571
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1572 case "marker"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1573 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
1574
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1575 case "markeredgealpha"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1576 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
1577 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
1578 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
1579 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
1580 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
1581 s.valid = "scalar";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1582
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1583 case "markeredgecolor"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1584 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
1585 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
1586 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
1587 @w{line markeredgecolor property}}.";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1588 s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1589 "@qcode{\"flat\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1590 valid_color});
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1591
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1592 case "markerfacealpha"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1593 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
1594 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
1595 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
1596 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
1597 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
1598 s.valid = "scalar";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1599
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1600 case "markerfacecolor"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1601 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
1602 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
1603 @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
1604 the ancestor axes. @xref{XREFlinemarkerfacecolor, , \
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1605 @w{line markerfacecolor property}}.";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1606 s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1607 "@qcode{\"flat\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1608 "@qcode{\"auto\"}", ...
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1609 valid_color});
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1610
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1611 case "seriesindex"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1612 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
1613 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
1614 @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
1615 set to @qcode{\"auto\"}.";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1616
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1617 case "sizedatasource"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1618 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
1619
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1620 case "sizedata"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1621 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
1622 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
1623 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
1624 s.valid = packopt ({"[]", "scalar", "vector"});
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1625
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1626 case "xdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1627 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
1628
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1629 case "xdata"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1630 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
1631 s.valid = "vector";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1632
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1633 case "ydatasource"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1634 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
1635
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1636 case "ydata"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1637 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
1638 s.valid = "vector";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1639
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1640 case "zdatasource"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1641 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
1642
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1643 case "zdata"
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1644 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
1645 object.";
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1646 s.valid = packopt ({"[]", "vector"});
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1647
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1648 endswitch
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1649
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1650 ## Light properties
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1651 elseif (strcmp (objname, "light"))
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1652 switch (field)
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1653 ## Overridden shared properties
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1654 case "children"
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1655 s.doc = doc_unused;
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1656
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1657 ## Specific properties
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1658 case "color"
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1659 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
1660 s.valid = valid_color;
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1661
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1662 case "position"
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1663 s.doc = "Position of the light source.";
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1664
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1665 case "style"
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1666 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
1667 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
1668 point source (@qcode{\"local\"}).";
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1669
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1670 endswitch
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21530
diff changeset
1671
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1672 ## uimenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1673 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
1674 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1675 ## 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
1676 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1677 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
1678
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1679 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1680 case "accelerator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1681 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1682 case "checked"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1683 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1684 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1685 case "label"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1686 case "position"
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1687 case "separator"
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1688
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1689 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1690
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1691 ## uicontextmenu properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1692 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
1693 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1694 ## 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
1695 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1696 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
1697
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1698 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1699 case "callback"
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1700 case "position"
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1701
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1702 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1703
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1704 ## uipanel properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1705 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
1706 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1707 ## 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
1708
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1709 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1710 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1711 case "bordertype"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1712 case "borderwidth"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1713 case "fontangle"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1714 s.doc = doc_fontangle;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1715
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1716 case "fontname"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1717 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
1718 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
1719
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1720 case "fontsize"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1721 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
1722 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1723
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1724 case "fontunits"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1725 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
1726
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1727 case "fontweight"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1728 s.doc = doc_fontweight;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1729
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1730 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1731 case "highlightcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1732 case "position"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1733
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1734 case "resizefcn"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1735 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
1736 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1737
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1738 case "shadowcolor"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1739
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1740 case "sizechangedfcn"
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1741 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
1742 \n\n__fcnmsg__";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1743 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1744
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1745 case "title"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1746 case "titleposition"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1747 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1748
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1749 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1750
21824
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1751 ## uibuttongroup properties
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1752 elseif (strcmp (objname, "uibuttongroup"))
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1753 switch (field)
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1754 ## Overridden shared properties
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1755
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1756 ## Specific properties
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1757 case "backgroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1758 case "bordertype"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1759 case "borderwidth"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1760 case "fontangle"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1761 s.doc = doc_fontangle;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1762
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1763 case "fontname"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1764 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
1765 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
1766
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1767 case "fontsize"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1768 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
1769 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1770
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1771 case "fontunits"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1772 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
1773
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1774 case "fontweight"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1775 s.doc = doc_fontweight;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1776
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1777 case "foregroundcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1778 case "highlightcolor"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1779 case "position"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1780
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1781 case "resizefcn"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1782 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
1783 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1784
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1785 case "selectedobject"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1786 case "selectionchangedfcn"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1787 case "shadowcolor"
26195
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1788
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1789 case "sizechangedfcn"
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1790 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
1791 \n\n__fcnmsg__";
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1792 s.valid = valid_fcn;
a5094f65012c Document "resizefcn", "sizechangedfcn" for uipanel, uibuttongroup objects (bug #55085).
Rik <rik@octave.org>
parents: 26122
diff changeset
1793
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1794 case "title"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1795 case "titleposition"
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1796 case "units"
21824
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1797
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1798 endswitch
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1799
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1800 ## uicontrol properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1801 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
1802 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1803 ## 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
1804
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1805 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1806 case "backgroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1807 case "callback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1808 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1809 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1810 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
1811 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
1812 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
1813 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
1814 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
1815 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
1816 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
1817 s.printdefault = false;
e06ce02f4f74 Don't print default value for "extent" property in manual (bug #54505).
Rik <rik@octave.org>
parents: 25054
diff changeset
1818
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1819 case "fontangle"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1820 s.doc = doc_fontangle;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1821
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1822 case "fontname"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1823 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
1824 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
1825
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1826 case "fontsize"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1827 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
1828 s.valid = "scalar";
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1829
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1830 case "fontunits"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1831 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
1832
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1833 case "fontweight"
23210
3a298e07002c Deprecate "light" and "demi" values for "fontweight" property (bug #50353).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23208
diff changeset
1834 s.doc = doc_fontweight;
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23395
diff changeset
1835
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1836 case "foregroundcolor"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1837 case "horizontalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1838 case "keypressfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1839 case "listboxtop"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1840 case "max"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1841 case "min"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1842 case "position"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1843 case "sliderstep"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1844 case "string"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1845 case "style"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1846 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1847 case "units"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1848 case "value"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1849 case "verticalalignment"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1850
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1851 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1852
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25998
diff changeset
1853 ## uitable Properties
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25998
diff changeset
1854 elseif (strcmp (objname, "uitable"))
26122
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1855 switch (field)
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1856 ## Overridden shared properties
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1857
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1858 ## Specific properties
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1859 case "backgroundcolor"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1860 case "celleditcallback"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1861 case "cellselectioncallback"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1862 case "columneditable"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1863 case "columnformat"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1864 case "columnname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1865 case "columnwidth"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1866 case "data"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1867 case "enable"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1868 case "extent"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1869 s.valid = valid_4elvec;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1870 s.printdefault = false;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1871
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1872 case "fontangle"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1873 s.doc = doc_fontangle;
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25998
diff changeset
1874
26122
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1875 case "fontname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1876 s.doc = doc_fontname;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1877 s.valid = valid_string;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1878
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1879 case "fontsize"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1880 s.doc = doc_fontsize;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1881 s.valid = "scalar";
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1882
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1883 case "fontunits"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1884 s.doc = doc_fontunits;
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25998
diff changeset
1885
26122
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1886 case "fontweight"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1887 s.doc = doc_fontweight;
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1888
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1889 case "foregroundcolor"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1890 case "keypressfcn"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1891 case "keyreleasefcn"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1892 case "position"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1893 case "rearrangeablecolumns"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1894 case "rowname"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1895 case "rowstriping"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1896 case "tooltipstring"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1897 case "units"
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1898
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
1899 endswitch
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25998
diff changeset
1900
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1901 ## uitoolbar properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1902 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
1903 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1904 ## 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
1905 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1906 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
1907
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1908 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1909
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1910 ## uipushtool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1911 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
1912 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1913 ## 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
1914 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1915 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
1916
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1917 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1918 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1919 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1920 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1921 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1922 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1923
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1924 endswitch
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1925
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1926 ## uitoggletool properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1927 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
1928 switch (field)
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1929 ## 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
1930 case "buttondownfcn"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1931 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
1932
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1933 ## Specific properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1934 case "cdata"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1935 case "clickedcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1936 case "enable"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1937 case "offcallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1938 case "oncallback"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1939 case "separator"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1940 case "state"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1941 case "tooltipstring"
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1942
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20478
diff changeset
1943 endswitch
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1944 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1945
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1946 ## Replace keywords
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1947 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1948 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
1949 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1950
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1951 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1952
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1953 function strout = expand_doc (strin, field, objname)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1954 strout = strrep (strin, "__objname__", objname);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1955 strout = strrep (strout, "__prop__", ["@code{" field "}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1956
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1957 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
1958 property to be set to @qcode{\"manual\"}";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1959 modemsg = sprintf (modemsg, field, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1960 strout = strrep (strout, "__modemsg__", modemsg);
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
1961 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
1962 functions see @ref{Callbacks, , @w{Callbacks section}}.";
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23202
diff changeset
1963 strout = strrep (strout, "__fcnmsg__", fcnmsg);
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1964 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1965
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1966 function s = getstructure (objname, base = [])
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1967 hf = [];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1968 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
1969 ## 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
1970 hf = figure (2265465, "visible", "off");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1971 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1972
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
1973 ## 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
1974 if (strcmp (objname, "base"))
21931
ffa911b616c7 * genpropdoc.m: Don't handle erasemode property.
John W. Eaton <jwe@octave.org>
parents: 21824
diff changeset
1975 ## 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
1976 ## regular (non-hidden) property, "displayname".
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1977 h = hggroup ();
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1978 elseif (strcmp (objname, "root"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1979 h = 0;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1980 elseif (strcmp (objname, "figure"))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1981 h = hf;
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1982 elseif (strcmp (objname, "scatter"))
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1983 ## 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
1984 hax = axes (hf);
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27957
diff changeset
1985 h = __go_scatter__ (hax);
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1986 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1987 eval (["h = " objname " ();"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1988 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
1989
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1990 gprop = get (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1991 sprop = set (h);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1992
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1993 fields = fieldnames (gprop);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1994 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1995 args = cell (2*nf, 1);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1996 for ii = 1:nf
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1997 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1998
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
1999 ## Get hard coded documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2000 val = getdoc (objname, field, base);
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2001
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2002 ## 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
2003 if (isempty (val.default) && val.printdefault)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2004 val.default = getdefault (h, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2005 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2006
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2007 val.isreadonly = ! isfield (sprop, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2008
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2009 ## 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
2010 if (! val.isreadonly && isempty (val.valid))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2011 val.valid = sprop.(field);
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2012 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
2013 ## Add double quotes around string radio properties
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2014 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
2015 "uniformoutput", false);
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2016 val.valid = strjoin (val.valid, " | ");
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2017 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2018 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2019
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2020 args{2*(ii-1)+1} = field;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2021 args{2*ii} = val;
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2022 endfor
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2023
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2024 ## 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
2025 s = struct (args{:});
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2026
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2027 if (strcmp (objname, "base"))
21931
ffa911b616c7 * genpropdoc.m: Don't handle erasemode property.
John W. Eaton <jwe@octave.org>
parents: 21824
diff changeset
2028 s = rmfield (s, "displayname");
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2029 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2030
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2031 if (isfigure (hf))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2032 close (hf)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2033 endif
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2034
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2035 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2036
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2037 function def = getdefault (h, objname, field)
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2038 ## 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
2039 ## 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
2040 def = get (h, field);
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2041
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2042 ## 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
2043 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
2044 def = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2045 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2046 if (ischar (def))
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2047 def = ['@qcode{"' def '"}'];
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2048 else
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2049 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
2050 ## 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
2051 ## empty values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2052 str = disp (def);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2053 str(end) = []; # remove linefeed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2054 str = strtrim (str); # remove leading space
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2055
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2056 ## Add [] around vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2057 if (ismatrix (def) && numel (def) > 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2058 str = ["[" str "]"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2059 ## Add ";" between columns vector values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2060 if (rows (def) != 1)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2061 str = strrep (str, "\n", "; ");
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2062 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2063 endif
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2064
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2065 ## Replace texinfo reserved characters
26122
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
2066 def = strrep (str, "@", "@@"); # must occur first
4d1c6c60f6b3 Clean up implementation of uitable in 36e0e5b428e7.
Rik <rik@octave.org>
parents: 26112
diff changeset
2067 def = strrep (def, "{", "@{");
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2068 def = strrep (def, "}", "@}");
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2069
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2070 def = ["@code{" def "}"];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2071 else
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2072 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
2073 def = [strjoin(args, "-by-") " " class(def)];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2074 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2075 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2076 endif
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2077
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2078 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2079
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2080 function str = printdoc (objname, obj)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2081 ## 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
2082 fields = sort (fieldnames (obj));
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2083 nf = numel (fields);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2084
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
2085 ## 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
2086 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
2087 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
2088 str = sprintf ("%s\n\nProperties of the root graphics object:", str);
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076).
Rik <rik@octave.org>
parents: 26376
diff changeset
2089 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
2090 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
2091 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
2092 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
2093 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
2094
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2095 for ii = 1:nf
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2096 field = fields{ii};
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2097 str = sprintf ("%s\n\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2098
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2099 ## @anchor: cross reference using XREFobjnamefield label
19824
0e585d3b8b9a genpropdoc.m: Improve documentation on graphic object properties.
Rik <rik@octave.org>
parents: 19792
diff changeset
2100 ## Concept index: call info from octave with 'doc ("objname field")'
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
2101 str = sprintf ("%s@anchor{XREF%s%s}\n@prindex %s %s\n",
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2102 str, objname, field, objname, field);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2103
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2104 ## Item
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2105 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
2106
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2107 ## Mark item read-only if needed
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2108 if (obj.(field).isreadonly)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2109 str = sprintf ("%s (read-only):", str);
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 str = sprintf ("%s:", str);
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 ## Print valid and default values
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2115 tmp = print_options (obj.(field).valid,
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2116 obj.(field).default);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2117 if (! isempty (tmp))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2118 str = sprintf ("%s %s\n", str, tmp);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2119 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2120 str = sprintf ("%s\n", str);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2121 endif
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2122
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2123 ## Print documentation
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2124 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
2125 endfor
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19407
diff changeset
2126
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2127 ## End of properties table
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2128 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
2129
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2130 endfunction
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 function str = warn_autogen ()
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2133 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
2134 \n\
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 26195
diff changeset
2135 @c Copyright (C) 2014-2019 Pantxo Diribarne\n\
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2136 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2137 @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
2138 @c\n\
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24523
diff changeset
2139 @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
2140 @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
2141 @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
2142 @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
2143 @c\n\
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24523
diff changeset
2144 @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
2145 @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
2146 @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
2147 @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
2148 @c\n\
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2149 @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
2150 @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
2151 @c <https://www.gnu.org/licenses/>.";
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2152 endfunction
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2153
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2154 function str = print_options (val, default)
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2155 str = "";
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2156 if (! isempty (val))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2157 tmp = strrep (val, default, ["@{" default "@}"]);
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2158 if (length (tmp) == length (val) && ! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2159 str = [tmp ", def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2160 else
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2161 str = tmp;
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 elseif (! isempty (default))
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2164 str = ["def. " default];
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2165 endif
20258
530803d4f65f Update root, figure, and axes graphics object properties.
Rik <rik@octave.org>
parents: 20101
diff changeset
2166
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
diff changeset
2167 endfunction