Mercurial > octave-nkf
diff doc/interpreter/genpropdoc.m @ 20293:530803d4f65f
Update root, figure, and axes graphics object properties.
* graphics.in.h: Update root, figure, and axes graphics object properties for
Matlab compatibility.
* genpropdoc.m: Update documentation for graphics object properties.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 10 Jun 2015 15:21:24 -0700 |
parents | e51473fdb622 |
children | 6db2ea5556a4 |
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m Tue Jun 09 21:38:46 2015 -0700 +++ b/doc/interpreter/genpropdoc.m Wed Jun 10 15:21:24 2015 -0700 @@ -123,6 +123,7 @@ case "busyaction" case "buttondownfcn" s.valid = valid_fcn; + case "children" s.doc = "Graphics handles of the __objname__'s children."; s.valid = "vector of graphics handles"; @@ -195,9 +196,9 @@ ## Specific properties case "callbackobject" + s.doc = "Graphics handle of the current object whose callback is executing."; s.valid = valid_handle; - case "commandwindowsize" case "currentfigure" s.doc = "Graphics handle of the current figure."; s.valid = valid_handle; @@ -282,6 +283,7 @@ ## Specific properties case "alphamap" s.doc = sprintf (doc_notimpl, "Transparency"); + case "closerequestfcn" s.valid = valid_fcn; @@ -325,10 +327,14 @@ s.doc = doc_unused; case "doublebuffer" + case "filename" - s.doc = "The filename used when saving the plot figure"; + s.doc = "The filename used when saving the plot figure."; s.valid = valid_string; + case "graphicssmoothing" + s.doc = doc_unused; + case "integerhandle" s.doc = "Assign the next lowest unused integer as the Figure number."; @@ -363,6 +369,10 @@ property."; s.valid = valid_string; + ## FIXME: Uncomment when support added in graphics.in.h + #case "number" + # s.doc = "Number of current figure (RO)."; + case "nextplot" case "numbertitle" @@ -388,7 +398,7 @@ case "papersize" s.doc = "Vector @code{[width height]} defining the size of the \ paper for printing. Setting this property forces the @code{papertype} \ -property to be set to @qcode{\"<custom>\"}."; +property to the value @qcode{\"<custom>\"}."; s.valid = valid_2elvec; case "papertype" @@ -410,15 +420,23 @@ case "renderer" case "renderermode" + case "resize" + s.doc = doc_unused; + case "resizefcn" s.valid = valid_fcn; case "selectiontype" - s.doc = doc_unused; + ## FIXME: docstring explaining what "{normal}|open|alt|extend" mean. + + case "sizechangedfcn" + s.valid = valid_fcn; case "toolbar" - s.doc = doc_unused; + s.doc = "Control the display of the toolbar along the bottom of the \ +figure window. When set to @qcode{\"auto\"}, the display is based on the \ +value of the @code{menubar} property."; case "units" s.doc = "The unit used to compute the @code{position} and \ @@ -452,6 +470,9 @@ s.valid = valid_fcn; case "windowstyle" + s.doc = doc_unused; + + ## FIXME: Need to deprecate these for 4.2 case "wvisual" case "wvisualmode" case "xdisplay" @@ -471,12 +492,17 @@ case "activepositionproperty" case "alim" s.doc = sprintf (doc_notimpl, "Transparency"); + case "alimmode" case "ambientlightcolor" s.doc = sprintf (doc_notimpl, "Light"); + case "box" s.doc = "Control whether the axes has a surrounding box."; + case "boxstyle" + s.doc = doc_unused; + case "cameraposition" s.valid = valid_3elvec; @@ -500,6 +526,9 @@ case "climmode" + case "clippingstyle" + s.doc = doc_unused; + case "color" s.doc = "Color of the axes background. @xref{Colors, , colorspec}."; s.valid = valid_color; @@ -509,6 +538,9 @@ coloring."; s.valid = "N-by-3 RGB matrix"; + case "colororderindex" + s.doc = doc_unused; + case "currentpoint" s.doc = "Matrix @code{[xf, yf, zf; xb, yb, zb]} which holds the \ coordinates (in axes data units) of the point over which the mouse pointer \ @@ -528,7 +560,6 @@ s.valid = valid_3elvec; case "dataaspectratiomode" - case "drawmode" case "fontangle" case "fontname" s.doc = "Name of the font used for axes annotations."; @@ -542,18 +573,53 @@ case "fontunits" s.doc = "Unit used to interpret @code{fontsize} property."; + case "fontsmoothing" + s.doc = doc_unused; + case "fontweight" + case "gridalpha" + s.doc = sprintf (doc_notimpl, "Transparency"); + + case "gridalphamode" + s.doc = doc_unused; + + case "gridcolor" + s.doc = doc_unused; + + case "gridcolormode" + s.doc = doc_unused; + case "gridlinestyle" case "interpreter" + case "labelfontsizemultiplier" + s.doc = doc_unused; + case "layer" s.doc = "Control whether the axes is drawn below child graphics \ objects (ticks, labels, etc. covered by plotted objects) or above."; case "linestyleorder" + s.doc = doc_unused; + + case "linestyleorderindex" + s.doc = doc_unused; case "linewidth" + + case "minorgridalpha" + s.doc = sprintf (doc_notimpl, "Transparency"); + + case "minorgridalphamode" + s.doc = doc_unused; + + case "minorgridcolor" + s.doc = doc_unused; + + case "minorgridcolormode" + s.doc = doc_unused; + case "minorgridlinestyle" case "mousewheelzoom" s.doc = "Fraction of axes limits to zoom for each wheel movement."; @@ -571,6 +637,9 @@ @xref{XREFaxesposition, , @w{position property}}."; s.valid = valid_4elvec; + case "pickableparts" + s.doc = doc_unused; + case "plotboxaspectratio" case "plotboxaspectratiomode" case "position" @@ -585,6 +654,10 @@ s.valid = valid_4elvec; case "projection" + s.doc = doc_unused; + + case "sortmethod" + s.doc = doc_unused; case "tickdir" s.doc = "Control whether axes tick marks project \"in\" to the plot \ @@ -602,6 +675,12 @@ s.doc = "Graphics handle of the title text object."; s.valid = valid_handle; + case "titlefontsizemultiplier" + s.doc = doc_unused; + + case "titlefontweight" + s.doc = doc_unused; + case "units" case "view" s.doc = "Two-element vector @code{[azimuth elevation]} specifying \ @@ -613,6 +692,9 @@ s.doc = "Color of the x-axis. @xref{Colors, , colorspec}."; s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"}); + case "xcolormode" + s.doc = doc_unused; + case "xdir" case "xgrid" s.doc = "Control whether major x grid lines are displayed."; @@ -641,12 +723,18 @@ s.valid = valid_cellstring; case "xticklabelmode" + case "xticklabelrotation" + s.doc = doc_unused; + case "xtickmode" case "yaxislocation" case "ycolor" s.doc = "Color of the y-axis. @xref{Colors, , colorspec}."; s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"}); + case "ycolormode" + s.doc = doc_unused; + case "ydir" case "ygrid" s.doc = "Control whether major y grid lines are displayed."; @@ -675,11 +763,17 @@ s.valid = valid_cellstring; case "yticklabelmode" + case "yticklabelrotation" + s.doc = doc_unused; + case "ytickmode" case "zcolor" s.doc = "Color of the z-axis. @xref{Colors, , colorspec}."; s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"}); + case "zcolormode" + s.doc = doc_unused; + case "zdir" case "zgrid" s.doc = "Control whether major z grid lines are displayed."; @@ -708,6 +802,9 @@ s.valid = valid_cellstring; case "zticklabelmode" + case "zticklabelrotation" + s.doc = doc_unused; + case "ztickmode" endswitch @@ -1335,4 +1432,5 @@ elseif (! isempty (default)) str = ["def. " default]; endif + endfunction