Mercurial > hg > octave-nkf
changeset 12189:9558ca33648d
Add functions reset, whitebg to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 27 Jan 2011 20:13:45 -0800 |
parents | 1e206c8713a7 |
children | 66b2c377b38e |
files | doc/ChangeLog doc/interpreter/image.txi doc/interpreter/plot.txi scripts/ChangeLog scripts/plot/whitebg.m src/ChangeLog src/graphics.cc |
diffstat | 7 files changed, 34 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2011-01-27 Rik <octave@nomad.inbox5.com> + + * interpreter/image.txi: Add whitebg function to documentation. + * interpreter/plot.txi: Add reset function to documentation. + 2011-01-27 Rik <octave@nomad.inbox5.com> * interpreter/linalg.txi: Add rsf2csf to documentation.
--- a/doc/interpreter/image.txi +++ b/doc/interpreter/image.txi @@ -127,8 +127,6 @@ @DOCSTRING(colormap) -@DOCSTRING(brighten) - @DOCSTRING(autumn) @DOCSTRING(bone) @@ -174,11 +172,15 @@ @DOCSTRING(gmap40) -You may use the @code{spinmap} function to cycle through the colors in -the current colormap, displaying the changes for the current figure. +The following three functions modify the existing colormap rather than +replace it. + +@DOCSTRING(brighten) @DOCSTRING(spinmap) +@DOCSTRING(whitebg) + @node Plotting on top of Images @section Plotting on top of Images
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -2415,7 +2415,10 @@ @noindent removes the user-defined default line color setting from the current axes -object. +object. To quickly remove all user-defined defaults use the @code{reset} +function. + +@DOCSTRING(reset) Getting the @code{"default"} property of an object returns a list of user-defined defaults set for the object. For example, @@ -2438,7 +2441,6 @@ @noindent returns a list of factory defaults. - @node Advanced Plotting @section Advanced Plotting
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2011-01-27 Rik <octave@nomad.inbox5.com> + + * plot/whitebg.m: Improve docstring. + 2011-01-27 Rik <octave@nomad.inbox5.com> * geometry/trimesh.m, geometry/triplot.m, geometry/trisurf.m: Add
--- a/scripts/plot/whitebg.m +++ b/scripts/plot/whitebg.m @@ -19,19 +19,21 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} whitebg () ## @deftypefnx {Function File} {} whitebg (@var{color}) +## @deftypefnx {Function File} {} whitebg ("none") ## @deftypefnx {Function File} {} whitebg (@var{fig}) ## @deftypefnx {Function File} {} whitebg (@var{fig}, @var{color}) +## @deftypefnx {Function File} {} whitebg (@var{fig}, "none") ## Invert the colors in the current color scheme. The root properties are ## also inverted such that all subsequent plot use the new color scheme. ## ## If defined, @var{fig} is the handle to the figure to be inverted. In -## this case only this figure has its color properties changed +## this case only the specified figure has its color properties changed. ## -## The background colors of the figure and its children can be set -## specifically if @var{color} is defined. @var{color} must be a valid -## color set as a string or an RGB triplet, or the value "none". -## -## @seealso{reset, colordef} +## If the optional argument @var{color} is present then the background color +## is set to @var{color} rather than inverted. @var{color} may be a string +## representing one of the eight known colors or an RGB triplet. The special +## string argument "none" restores the plot to the default colors. +## @seealso{reset} ## @end deftypefn function whitebg (varargin) @@ -133,7 +135,7 @@ ## Is this the right thing to do in this case? set (findall (fig, "type", "axes"), "color", color); if (isroot) - defs = get (0, "defaults"); + defs = get (0, "default"); if (isfield (defs, "defaultaxescolor") && strcmp (defs.defaultaxescolor, "none")) set (0, "defaultaxescolor", color);
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2011-01-27 Rik <octave@nomad.inbox5.com> + + * graphics.cc: Improve reset docstring. + 2011-01-27 Kai Habel <kai.habel@gmx.de> * DLD-FUNCTIONS/__init_fltk__.cc (__fltk_uigetfile__): Remove here.
--- a/src/graphics.cc +++ b/src/graphics.cc @@ -5964,8 +5964,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} reset (@var{h}, @var{property})\n\ Remove any defaults set for the handle @var{h}. The default figure\n\ -properties \"position\", \"units\", \"windowstyle\" and\n\ -\"paperunits\" and the default axes properties \"position\" and \"units\"\n\ +properties of \"position\", \"units\", \"windowstyle\" and\n\ +\"paperunits\" and the default axes properties of \"position\" and \"units\"\n\ are not reset.\n\ @end deftypefn") {