view scripts/gui/uifigure.m @ 31253:a40c0b7aa376

maint: changes to follow Octave coding conventions. * NEWS.8.md: Wrap lines to 72 chars. * LSODE-opts.in: Use two spaces after sentence ending period. * LSODE.cc: Use minimum of two spaces between code and start of comment. * MemoizedFunction.m: Change copyright date to 2022 since this is the year it was accepted into core. Don't wrap error() lines to 80 chars. Use newlines to improve readability of switch statements. Use minimum of two spaces between code and start of comment. * del2.m, integral.m, interp1.m, interp2.m, griddata.m, inpolygon.m, waitbar.m, cubehelix.m, ind2x.m, importdata.m, textread.m, logm.m, lighting.m, shading.m, xticklabels.m, yticklabels.m, zticklabels.m, colorbar.m, meshc.m, print.m, __gnuplot_draw_axes__.m, struct2hdl.m, ppval.m, ismember.m, iqr.m: Use a space between comment character '#' and start of comment. Use hyphen for adjectives describing dimensions such as "1-D". * vectorize.m, ode23s.m: Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. * clearAllMemoizedCaches.m: Change copyright date to 2022 since this is the year it was accepted into core. Remove input validation which is done by interpreter. Use two newlines between end of code and start of BIST tests. * memoize.m: Change copyright date to 2022 since this is the year it was accepted into core. Re-wrap documentation to 80 chars. Use is_function_handle() instead of "isa (x, "function_handle")" for clarity and performance. Use two newlines between end of code and start of BIST tests. Use semicolon for assert statements within %!test block. Re-write BIST tests for input validation. * __memoize__.m: Change copyright date to 2022 since this is the year it was accepted into core. Use spaces in for statements to improve readability. * unique.m: Add FIXME note to commented BIST test * dec2bin.m: Remove stray newline at end of file. * triplequad.m: Reduce doubly-commented BIST syntax using "#%!#" to "#%!". * delaunayn.m: Use input variable names in error() statements. Use minimum of two spaces between code and start of comment. Use hyphen for describing dimensions. Use two newlines between end of code and start of BIST tests. Update BIST tests to pass.
author Rik <rik@octave.org>
date Mon, 03 Oct 2022 18:06:55 -0700
parents e3016248ca5d
children 597f3ee61a48
line wrap: on
line source

########################################################################
##
## 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");

  ## Add uifigure-specific properties on top of regular figure graphics object
  ## FIXME: There is no implementation behind these properties.
  addproperty ("AutoResizeChildren", h, "boolean", "on");
  addproperty ("Scrollable", h, "boolean", "off");

  ## Apply any overrides.
  if (! isempty (varargin))
    set (h, varargin{:});
  endif

endfunction


%!test
%! hf = uifigure ("visible", "off");
%! unwind_protect
%!   assert (isfigure (hf));
%!   assert (get (hf, {"numbertitle", "menubar", "scrollable"}),
%!                    {"off", "none", "off"});
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!error <parameters must occur in pairs> uifigure ("PROP1")