changeset 31005:81b51b823663

uifigure.m: Add new function. * NEWS.8.md: Announce new function. * scripts/gui/uifigure.m: New function. * scripts/gui/module.mk: Add uifigure.m to build system. * gui.txi: Add docstring to manual.
author Rik <rik@octave.org>
date Tue, 17 May 2022 14:38:40 -0700
parents 01bdfc4bb12e
children 497de29f6946
files doc/interpreter/gui.txi etc/NEWS.8.md scripts/gui/module.mk scripts/gui/uifigure.m
diffstat 4 files changed, 75 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/gui.txi	Sun May 15 18:06:27 2022 -0700
+++ b/doc/interpreter/gui.txi	Tue May 17 14:38:40 2022 -0700
@@ -108,6 +108,8 @@
 toolkit, although some functionality is available with the @code{fltk} toolkit.
 There is no support for the @code{gnuplot} toolkit.
 
+@DOCSTRING(uifigure)
+
 @DOCSTRING(uipanel)
 
 @DOCSTRING(uibuttongroup)
--- a/etc/NEWS.8.md	Sun May 15 18:06:27 2022 -0700
+++ b/etc/NEWS.8.md	Tue May 17 14:38:40 2022 -0700
@@ -44,6 +44,7 @@
 
 ### Alphabetical list of new functions added in Octave 8
 
+* `uifigure`
 
 ### Deprecated functions, properties, and operators
 
--- a/scripts/gui/module.mk	Sun May 15 18:06:27 2022 -0700
+++ b/scripts/gui/module.mk	Tue May 17 14:38:40 2022 -0700
@@ -36,6 +36,7 @@
   %reldir%/uicontrol.m \
   %reldir%/uigetdir.m \
   %reldir%/uigetfile.m \
+  %reldir%/uifigure.m \
   %reldir%/uimenu.m \
   %reldir%/uipanel.m \
   %reldir%/uipushtool.m \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/gui/uifigure.m	Tue May 17 14:38:40 2022 -0700
@@ -0,0 +1,71 @@
+########################################################################
+##
+## Copyright (C) 2022 The Octave Project Developers
+##
+## See the file COPYRIGHT.md in the top-level directory of this
+## distribution or <https://octave.org/copyright/>.
+##
+## This file is part of Octave.
+##
+## Octave is free software: you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <https://www.gnu.org/licenses/>.
+##
+########################################################################
+
+## -*- texinfo -*-
+## @deftypefn  {} {@var{h} =} uifigure ()
+## @deftypefnx {} {@var{h} =} uifigure ("@var{property}", @var{value}, @dots{})
+## Create a new figure window for applications.
+##
+## Multiple property-value pairs may be specified for the figure object, but
+## they must occur in pairs.
+##
+## The return value @var{h} is a graphics handle to the created figure object.
+##
+## Programming Note: The full list of properties is documented at
+## @ref{Figure Properties}.  This function differs from @code{figure} in that
+## the created figure is optimized for application development, rather than
+## plotting.  This means features such as menubars and toolbars are turned off.
+## @seealso{uipanel, uibuttongroup}
+## @end deftypefn
+
+## FIXME: This is not a perfect replica of a Matlab uifigure object because
+## some ordinary figure object properties are exposed (e.g., the "PaperXXX"
+## properties).  In addition, the following properties are missing:
+## "AutoResizeChildren", "Icon", "Scrollable".
+
+function h = uifigure (varargin)
+
+  if (mod (nargin, 2) != 0)
+    error ("uifigure: PROPERTY/VALUE parameters must occur in pairs");
+  endif
+
+  h = __go_figure__ (NaN, "handlevisibility", "off",
+                          "numbertitle", "off", "integerhandle", "off",
+                          "menubar", "none", "toolbar", "none", 
+                          varargin{:});
+
+endfunction
+
+
+%!test
+%! hf = uifigure ("visible", "off");
+%! unwind_protect
+%!   assert (isfigure (hf));
+%!   assert (get (hf, {"numbertitle", "menubar"}), {"off", "none"});
+%! unwind_protect_cleanup
+%!   close (hf);
+%! end_unwind_protect
+
+%!error <parameters must occur in pairs> uifigure ("PROP1")