Mercurial > octave
view scripts/gui/movegui.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 7854d5752dd2 |
children | c8ad083a5802 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2018-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. ## 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 filename COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} movegui ## @deftypefnx {} {} movegui (@var{h}) ## @deftypefnx {} {} movegui (@var{pos}) ## @deftypefnx {} {} movegui (@var{h}, @var{pos}) ## @deftypefnx {} {} movegui (@var{h}, @var{event}) ## @deftypefnx {} {} movegui (@var{h}, @var{event}, @var{pos}) ## Move a figure specified by figure handle @var{h} to a position on the screen ## defined by @var{pos}. ## ## @var{h} is a figure handle, or a handle to a graphics object. In the latter ## case, its parent figure will be used. If unspecified, @var{h} will be ## set to the handle of the relevant figure if a callback is being executed ## (@code{gcbf}), otherwise it will be set to the handle of the current figure ## (@code{gcf}). ## ## @var{pos} is either a two-value numeric vector or a string. If @var{pos} is ## numeric then it must be of the form @code{[h, v]} specifying the horizontal ## and vertical offsets of the figure with respect to the screen. A positive ## value indicates the offset between the left (or bottom for the vertical ## component) of the screen, and the left (or bottom) of the figure. A ## negative value indicates the offset between the right (or top) of the screen ## and the right (or top) of the figure. ## ## Possible values for @var{pos} as a string are ## ## @table @code ## @item north ## Top center of the screen. ## ## @item south ## Bottom center of the screen. ## ## @item east ## Right center of the screen. ## ## @item west ## Left center of the screen. ## ## @item northeast ## Top right of the screen. ## ## @item northwest ## Top left of the screen. ## ## @item southeast ## Bottom right of the screen. ## ## @item southwest ## Bottom left of the screen. ## ## @item center ## Center of the screen. ## ## @item onscreen (default) ## The figure will be minimally moved to be entirely visible on the screen, ## with a 30 pixel extra padding from the sides of the screen. This is the ## default value if none is provided. ## @end table ## ## @var{event} contains event data that will be ignored. This construct ## facilitates a call to movegui from a callback. ## ## @end deftypefn function movegui (varargin) if (nargin > 3) print_usage (); endif ## Default values for input arguments h = []; pos = "onscreen"; ## Get input arguments if (nargin == 3) h = varargin{1}; pos = varargin{3}; elseif (nargin == 2) h = varargin{1}; pos = varargin{2}; elseif (nargin == 1) if (ishghandle (varargin{1}) && isscalar (varargin{1})) h = varargin{1}; else pos = varargin{1}; endif endif ## Check figure handle if (isempty (h)) h = gcbf (); if (isempty (h)) h = gcf (); endif elseif (ishghandle (h)) h = ancestor (h, "figure"); else error ("movegui: H must be a graphics handle"); endif ## Get current position in pixels units_fig = get (h, "units"); set (h, "units", "pixels"); fpos = get (h, "position"); # OuterPosition seems unreliable set (h, "units", units_fig); ## Get screen size in pixels units_groot = get (groot (), "units"); set (groot (), "units", "pixels"); screen_size = get (groot (), "ScreenSize"); set (groot (), "units", units_groot); ## Set default figure and screen border sizes [left, top, right, bottom] f = [0, 90, 0, 30]; s = [0, 0, 0, 30]; ## Make sure figure is not larger than screen fpos(1) = max (fpos(1), 1); fpos(2) = max (fpos(2), 1); fpos(3) = min (fpos(3), screen_size(3)); fpos(4) = min (fpos(4), screen_size(4)); ## Standard figure coordinates ## left, middle, right x = [s(1)+f(1), (screen_size(3)-fpos(3))/2, screen_size(3)-fpos(3)-s(3)-f(3)]; ## bottom, middle top y = [s(4)+f(4), (screen_size(4)-fpos(4))/2, screen_size(4)-fpos(4)-s(2)-f(2)]; ## Compute new position if (isnumeric (pos) && isreal (pos) && numel (pos) == 2) fpos(1) = ifelse (pos(1) >= 0, pos(1), pos(1) + x(3)); fpos(2) = ifelse (pos(2) >= 0, pos(2), pos(2) + y(3)); elseif (ischar (pos)) switch (tolower (pos)) case "north" fpos(1:2) = [x(2), y(3)]; case "south" fpos(1:2) = [x(2), y(1)]; case "east" fpos(1:2) = [x(3), y(2)]; case "west" fpos(1:2) = [x(1), y(2)]; case "northeast" fpos(1:2) = [x(3), y(3)]; case "northwest" fpos(1:2) = [x(1), y(3)]; case "southeast" fpos(1:2) = [x(3), y(1)]; case "southwest" fpos(1:2) = [x(1), y(1)]; case "center" fpos(1:2) = [x(2), y(2)]; case "onscreen" if (fpos(1) > x(3)) fpos(1) = x(3) - 30; endif if (fpos(2) > y(3)) fpos(2) = y(3) - 30; endif fpos(1) = max (fpos(1), 30); fpos(2) = max (fpos(2), 30); otherwise error ("movegui: invalid position"); endswitch elseif (nargin == 2 && ! isempty (gcbo)) ## Ignore event data (from callback) movegui (h); return; else error ("movegui: invalid position"); endif ## Move figure set (h, "units", "pixels"); set (h, "position", fpos); set (h, "units", units_fig); endfunction ## FIXME: This test does not verify the results, only that the function ## can be invoked by different methods. %!test %! unwind_protect %! h = figure ("visible", "off"); %! pos = {[10 10], [10 -10], [-10 10], [-10 -10], [10 10]',... %! "north", "east", "south", "west", ... %! "northwest", "northeast", "southeast", "southwest", ... %! "center", "onscreen"}; %! for i = 1:numel (pos) %! movegui (h, pos{i}); %! movegui (pos{i}); %! movegui (h, struct ("evt", []), pos{i}); %! endfor %! movegui (); %! movegui (h); %! unwind_protect_cleanup %! close (h); %! end_unwind_protect ## Test input validation %!error movegui (1,2,3,4) %!error <H must be a graphics handle> movegui (-1, [1,1]) %!error <invalid position> %! unwind_protect %! h = figure ("visible", "off"); %! movegui (h, "foobar"); %! unwind_protect_cleanup %! close (h); %! end_unwind_protect %!error <invalid position> %! unwind_protect %! h = figure ("visible", "off"); %! movegui (h, [1, 2, 3]); %! unwind_protect_cleanup %! close (h); %! end_unwind_protect