annotate scripts/gui/uifigure.m @ 31237:e3016248ca5d

uifigure.m: Call set () only if varargin is not empty (bug #63088) * uifigure.m: Call set () only if varargin is not empty.
author John Donoghue <john.donoghue@ieee.org>
date Wed, 21 Sep 2022 09:55:32 -0400
parents f44e19671777
children 597f3ee61a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31005
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
1 ########################################################################
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
3 ## Copyright (C) 2022 The Octave Project Developers
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
7 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
8 ## This file is part of Octave.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
13 ## (at your option) any later version.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
18 ## GNU General Public License for more details.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
19 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
22 ## <https://www.gnu.org/licenses/>.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
23 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
24 ########################################################################
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
25
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
26 ## -*- texinfo -*-
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
27 ## @deftypefn {} {@var{h} =} uifigure ()
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
28 ## @deftypefnx {} {@var{h} =} uifigure ("@var{property}", @var{value}, @dots{})
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
29 ## Create a new figure window for applications.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
30 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
31 ## Multiple property-value pairs may be specified for the figure object, but
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
32 ## they must occur in pairs.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
33 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
34 ## The return value @var{h} is a graphics handle to the created figure object.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
35 ##
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
36 ## Programming Note: The full list of properties is documented at
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
37 ## @ref{Figure Properties}. This function differs from @code{figure} in that
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
38 ## the created figure is optimized for application development, rather than
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
39 ## plotting. This means features such as menubars and toolbars are turned off.
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
40 ## @seealso{uipanel, uibuttongroup}
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
41 ## @end deftypefn
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
42
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
43 ## FIXME: This is not a perfect replica of a Matlab uifigure object because
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
44 ## some ordinary figure object properties are exposed (e.g., the "PaperXXX"
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
45 ## properties). In addition, the following properties are missing:
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
46 ## "AutoResizeChildren", "Icon", "Scrollable".
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
47
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
48 function h = uifigure (varargin)
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
49
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
50 if (mod (nargin, 2) != 0)
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
51 error ("uifigure: PROPERTY/VALUE parameters must occur in pairs");
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
52 endif
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
53
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
54 h = __go_figure__ (NaN, "handlevisibility", "off",
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
55 "numbertitle", "off", "integerhandle", "off",
31021
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
56 "menubar", "none", "toolbar", "none");
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
57
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
58 ## Add uifigure-specific properties on top of regular figure graphics object
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
59 ## FIXME: There is no implementation behind these properties.
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
60 addproperty ("AutoResizeChildren", h, "boolean", "on");
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
61 addproperty ("Scrollable", h, "boolean", "off");
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
62
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
63 ## Apply any overrides.
31237
e3016248ca5d uifigure.m: Call set () only if varargin is not empty (bug #63088)
John Donoghue <john.donoghue@ieee.org>
parents: 31021
diff changeset
64 if (! isempty (varargin))
e3016248ca5d uifigure.m: Call set () only if varargin is not empty (bug #63088)
John Donoghue <john.donoghue@ieee.org>
parents: 31021
diff changeset
65 set (h, varargin{:});
e3016248ca5d uifigure.m: Call set () only if varargin is not empty (bug #63088)
John Donoghue <john.donoghue@ieee.org>
parents: 31021
diff changeset
66 endif
31005
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
67
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
68 endfunction
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
69
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
70
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
71 %!test
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
72 %! hf = uifigure ("visible", "off");
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
73 %! unwind_protect
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
74 %! assert (isfigure (hf));
31021
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
75 %! assert (get (hf, {"numbertitle", "menubar", "scrollable"}),
f44e19671777 uifgure.m: Add additional uifigure-specific properties for Matlab compatibility.
Rik <rik@octave.org>
parents: 31005
diff changeset
76 %! {"off", "none", "off"});
31005
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
77 %! unwind_protect_cleanup
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
78 %! close (hf);
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
79 %! end_unwind_protect
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
80
81b51b823663 uifigure.m: Add new function.
Rik <rik@octave.org>
parents:
diff changeset
81 %!error <parameters must occur in pairs> uifigure ("PROP1")