Mercurial > hg > octave-lyh
annotate scripts/plot/whitebg.m @ 16491:b10a23fe80bb
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
* scripts/audio/wavread.m, scripts/miscellaneous/getappdata.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ver.m,
scripts/plot/daspect.m, scripts/plot/graphics_toolkit.m,
scripts/plot/pbaspect.m, scripts/polynomial/splinefit.m, scripts/set/union.m,
scripts/signal/freqz.m: Improve docstring wording.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 10 Apr 2013 22:43:30 -0700 |
| parents | 5d3a684236b0 |
| children | eaab03308c0b |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
1 ## Copyright (C) 2010-2012 David Bateman |
| 10725 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10725
diff
changeset
|
20 ## @deftypefn {Function File} {} whitebg () |
| 10725 | 21 ## @deftypefnx {Function File} {} whitebg (@var{color}) |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
22 ## @deftypefnx {Function File} {} whitebg ("none") |
| 10725 | 23 ## @deftypefnx {Function File} {} whitebg (@var{fig}) |
| 24 ## @deftypefnx {Function File} {} whitebg (@var{fig}, @var{color}) | |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
25 ## @deftypefnx {Function File} {} whitebg (@var{fig}, "none") |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10725
diff
changeset
|
26 ## Invert the colors in the current color scheme. The root properties are |
| 10725 | 27 ## also inverted such that all subsequent plot use the new color scheme. |
| 28 ## | |
| 29 ## If defined, @var{fig} is the handle to the figure to be inverted. In | |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
30 ## this case only the specified figure has its color properties changed. |
| 10725 | 31 ## |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
32 ## If the optional argument @var{color} is present then the background color |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
33 ## is set to @var{color} rather than inverted. @var{color} may be a string |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
34 ## representing one of the eight known colors or an RGB triplet. The special |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
35 ## string argument "none" restores the plot to the default colors. |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
36 ## @seealso{reset} |
| 10725 | 37 ## @end deftypefn |
| 38 | |
| 39 function whitebg (varargin) | |
| 40 h = 0; | |
| 41 color = NaN; | |
| 42 | |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
43 if (nargin > 0 && nargin < 3) |
| 10725 | 44 if (ishandle (varargin{1})) |
| 45 h = varargin{1}; | |
| 46 if (nargin == 2) | |
| 47 color = varargin{2}; | |
| 48 endif | |
| 49 elseif (nargin == 1) | |
| 50 color = varargin{1}; | |
| 51 else | |
| 52 print_usage (); | |
| 53 endif | |
| 54 elseif (nargin != 0) | |
| 55 print_usage (); | |
| 56 endif | |
| 57 | |
| 58 typ = get (h, "type"); | |
| 59 | |
| 60 if (strcmp (typ, "root")) | |
| 61 isroot = true; | |
| 62 fig = gcf (); | |
| 63 elseif (strcmp (typ, "figure")) | |
| 64 isroot = false; | |
| 65 fig = h; | |
| 66 else | |
| 67 error ("expecting a figure handle"); | |
| 68 endif | |
| 69 | |
| 70 axes = findall (fig, "type", "axes"); | |
| 71 if (isnan (color)) | |
| 72 ## Root figure. Set the default axes and figure properties so that | |
| 73 ## subsequent plots have the new color scheme | |
| 74 if (isroot) | |
| 75 fac = get (0, "factory"); | |
| 76 fields = fieldnames (fac); | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
77 fieldindex = intersect (find (!cellfun ("isempty", regexp (fields, 'color'))), union (find (!cellfun ("isempty", regexp (fields, 'factoryaxes.*'))), find (!cellfun ("isempty", regexp (fields, 'factoryfigure.*'))))); |
| 10725 | 78 |
| 79 ## Check whether the factory value has been replaced | |
| 80 for nf = 1 : numel (fieldindex); | |
| 81 defaultfield = strrep (fields {fieldindex (nf)}, "factory", "default"); | |
| 82 try | |
| 83 defaultvalue = 1 - get (0, defaultfield {n}); | |
| 84 catch | |
| 85 field = fields {fieldindex (nf)}; | |
| 86 defaultvalue = 1 - subsref (fac, struct ("type", ".", "subs", field)); | |
| 87 end_try_catch | |
| 88 set (0, defaultfield, defaultvalue); | |
| 89 endfor | |
| 90 endif | |
| 91 | |
| 92 ## Load all objects which qualify for being searched. | |
| 93 handles = fig; | |
| 94 h = fig; | |
| 95 while (numel (handles)) | |
| 96 children = []; | |
| 97 for n = 1 : numel (handles) | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
98 children = union (children, get (handles(n), "children")); |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
99 endfor |
| 10725 | 100 handles = children; |
| 101 h = union (h, children); | |
| 102 endwhile | |
| 103 | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
104 for nh = 1 : numel (h) |
| 10725 | 105 p = get (h (nh)); |
| 106 fields = fieldnames (p); | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
107 fieldindex = find (!cellfun ("isempty", regexp (fields, 'color'))); |
| 10725 | 108 if (numel (fieldindex)) |
| 109 for nf = 1 : numel (fieldindex); | |
| 110 field = fields {fieldindex (nf)}; | |
| 111 c = subsref (p, struct ("type", ".", "subs", field)); | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
112 if (! ischar (c) && columns (c) == 3) |
| 10725 | 113 set (h (nh), field, 1 - c); |
| 114 endif | |
| 115 endfor | |
| 116 endif | |
| 117 | |
| 118 ## If h(nh) is a figure or axes invert default color properties | |
| 119 typ = subsref (p, struct ("type", ".", "subs", "type")); | |
| 120 if (strcmp (typ, "axes") || strcmp (typ, "figure")) | |
| 121 def = get (h (nh), "default"); | |
| 122 fields = fieldnames (def); | |
| 123 if (! isempty (fields)) | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
124 fieldindex = find (!cellfun ("isempty", regexp (fields, 'color'))); |
| 10725 | 125 for nf = 1 : numel (fieldindex) |
| 126 defaultfield = fields {fieldindex (nf)}; | |
| 127 defaultvalue = 1 - subsref (def, struct ("type", ".", "subs", defaultfield)); | |
| 128 set (h (nh), defaultfield, defaultvalue); | |
| 129 endfor | |
| 130 endif | |
| 131 endif | |
| 132 endfor | |
| 133 else | |
| 134 ## FIXME | |
| 135 ## Is this the right thing to do in this case? | |
| 136 set (findall (fig, "type", "axes"), "color", color); | |
| 137 if (isroot) | |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
138 defs = get (0, "default"); |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
139 if (isfield (defs, "defaultaxescolor") |
| 10725 | 140 && strcmp (defs.defaultaxescolor, "none")) |
| 141 set (0, "defaultaxescolor", color); | |
| 142 endif | |
| 143 endif | |
| 144 endif | |
| 145 endfunction | |
| 13096 | 146 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
147 |
| 13096 | 148 %!test |
|
13111
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
149 %! dac = get (0, "defaultaxescolor"); |
|
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
150 %! dfc = get (0, "defaultfigurecolor"); |
|
13124
2ea1658ad049
Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents:
13116
diff
changeset
|
151 %! hf = figure ("visible", "off"); |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13136
diff
changeset
|
152 %! unwind_protect |
| 13096 | 153 %! l = line; |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
154 %! assert (get (hf, "color"), dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
155 %! assert (get (gca, "color"), dac); |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
156 %! whitebg (hf); |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
157 %! assert (get (hf, "color"), 1 - dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
158 %! assert (get (gca, "color"), 1 - dac); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
159 %! c = [0.2 0.2 0.2]; |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
160 %! whitebg (hf, c); |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
161 %! assert (get (hf, "color"), 1 - dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
162 %! assert (get (gca, "color"), c); |
| 13096 | 163 %! unwind_protect_cleanup |
| 164 %! close (hf); | |
| 165 %! end_unwind_protect | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
166 |