Mercurial > hg > octave-nkf
annotate scripts/plot/whitebg.m @ 19669:c2031ad6dbe7
Fix octave header includes in audiodevinfo
* audiodevinfo.cc: change includes to use local octave headers
| author | Vytautas Jančauskas <unaudio@gmail.com> |
|---|---|
| date | Wed, 11 Sep 2013 21:32:14 +0300 |
| parents | bc924baa2c4e |
| children |
| 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") |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
23 ## @deftypefnx {Function File} {} whitebg (@var{hfig}, @dots{}) |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
24 ## Invert the colors in the current color scheme. |
| 10725 | 25 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
26 ## The root properties are also inverted such that all subsequent plot use the |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
27 ## new color scheme. |
| 10725 | 28 ## |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
29 ## 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
|
30 ## 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
|
31 ## representing one of the eight known colors or an RGB triplet. The special |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
32 ## string argument @qcode{"none"} restores the plot to the default colors. |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
33 ## |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
34 ## If the first argument @var{hfig} is a figure handle, then operate on |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
35 ## this figure rather than the current figure returned by @code{gcf}. The |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
36 ## root properties will not be changed. |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
37 ## @seealso{reset, get, set} |
| 10725 | 38 ## @end deftypefn |
| 39 | |
| 40 function whitebg (varargin) | |
| 41 h = 0; | |
| 42 color = NaN; | |
| 43 | |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
44 if (nargin > 0 && nargin < 3) |
| 10725 | 45 if (ishandle (varargin{1})) |
| 46 h = varargin{1}; | |
| 47 if (nargin == 2) | |
| 48 color = varargin{2}; | |
| 49 endif | |
| 50 elseif (nargin == 1) | |
| 51 color = varargin{1}; | |
| 52 else | |
| 53 print_usage (); | |
| 54 endif | |
| 55 elseif (nargin != 0) | |
| 56 print_usage (); | |
| 57 endif | |
| 58 | |
| 59 typ = get (h, "type"); | |
| 60 | |
| 61 if (strcmp (typ, "root")) | |
| 62 isroot = true; | |
| 63 fig = gcf (); | |
| 64 elseif (strcmp (typ, "figure")) | |
| 65 isroot = false; | |
| 66 fig = h; | |
| 67 else | |
| 68 error ("expecting a figure handle"); | |
| 69 endif | |
| 70 | |
| 71 axes = findall (fig, "type", "axes"); | |
| 72 if (isnan (color)) | |
| 73 ## Root figure. Set the default axes and figure properties so that | |
| 74 ## subsequent plots have the new color scheme | |
| 75 if (isroot) | |
| 76 fac = get (0, "factory"); | |
| 77 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
|
78 fieldindex = intersect (find (!cellfun ("isempty", regexp (fields, 'color'))), union (find (!cellfun ("isempty", regexp (fields, 'factoryaxes.*'))), find (!cellfun ("isempty", regexp (fields, 'factoryfigure.*'))))); |
| 10725 | 79 |
| 80 ## Check whether the factory value has been replaced | |
| 81 for nf = 1 : numel (fieldindex); | |
| 82 defaultfield = strrep (fields {fieldindex (nf)}, "factory", "default"); | |
| 83 try | |
| 84 defaultvalue = 1 - get (0, defaultfield {n}); | |
| 85 catch | |
| 86 field = fields {fieldindex (nf)}; | |
| 87 defaultvalue = 1 - subsref (fac, struct ("type", ".", "subs", field)); | |
| 88 end_try_catch | |
| 89 set (0, defaultfield, defaultvalue); | |
| 90 endfor | |
| 91 endif | |
| 92 | |
| 93 ## Load all objects which qualify for being searched. | |
| 94 handles = fig; | |
| 95 h = fig; | |
| 96 while (numel (handles)) | |
| 97 children = []; | |
| 98 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
|
99 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
|
100 endfor |
| 10725 | 101 handles = children; |
| 102 h = union (h, children); | |
| 103 endwhile | |
| 104 | |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
105 for nh = 1 : numel (h) |
| 10725 | 106 p = get (h (nh)); |
| 107 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
|
108 fieldindex = find (!cellfun ("isempty", regexp (fields, 'color'))); |
| 10725 | 109 if (numel (fieldindex)) |
| 110 for nf = 1 : numel (fieldindex); | |
| 111 field = fields {fieldindex (nf)}; | |
| 112 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
|
113 if (! ischar (c) && columns (c) == 3) |
| 10725 | 114 set (h (nh), field, 1 - c); |
| 115 endif | |
| 116 endfor | |
| 117 endif | |
| 118 | |
| 119 ## If h(nh) is a figure or axes invert default color properties | |
| 120 typ = subsref (p, struct ("type", ".", "subs", "type")); | |
| 121 if (strcmp (typ, "axes") || strcmp (typ, "figure")) | |
| 122 def = get (h (nh), "default"); | |
| 123 fields = fieldnames (def); | |
| 124 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
|
125 fieldindex = find (!cellfun ("isempty", regexp (fields, 'color'))); |
| 10725 | 126 for nf = 1 : numel (fieldindex) |
| 127 defaultfield = fields {fieldindex (nf)}; | |
| 128 defaultvalue = 1 - subsref (def, struct ("type", ".", "subs", defaultfield)); | |
| 129 set (h (nh), defaultfield, defaultvalue); | |
| 130 endfor | |
| 131 endif | |
| 132 endif | |
| 133 endfor | |
| 134 else | |
| 135 ## FIXME | |
| 136 ## Is this the right thing to do in this case? | |
| 137 set (findall (fig, "type", "axes"), "color", color); | |
| 138 if (isroot) | |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
139 defs = get (0, "default"); |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
140 if (isfield (defs, "defaultaxescolor") |
| 10725 | 141 && strcmp (defs.defaultaxescolor, "none")) |
| 142 set (0, "defaultaxescolor", color); | |
| 143 endif | |
| 144 endif | |
| 145 endif | |
| 146 endfunction | |
| 13096 | 147 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
148 |
| 13096 | 149 %!test |
|
13111
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
150 %! dac = get (0, "defaultaxescolor"); |
|
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
151 %! 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
|
152 %! 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
|
153 %! unwind_protect |
| 13096 | 154 %! l = line; |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
155 %! assert (get (hf, "color"), dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
156 %! assert (get (gca, "color"), dac); |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
157 %! whitebg (hf); |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
158 %! assert (get (hf, "color"), 1 - dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
159 %! assert (get (gca, "color"), 1 - dac); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
160 %! c = [0.2 0.2 0.2]; |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13124
diff
changeset
|
161 %! whitebg (hf, c); |
|
13116
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
162 %! assert (get (hf, "color"), 1 - dfc); |
|
9fc95b9f8001
Avoid touching default values.
Kai Habel <kai.habel@gmx.de>
parents:
13111
diff
changeset
|
163 %! assert (get (gca, "color"), c); |
| 13096 | 164 %! unwind_protect_cleanup |
| 165 %! close (hf); | |
| 166 %! end_unwind_protect | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
167 |