Mercurial > octave
view scripts/gui/uibuttongroup.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 30 Mar 2022 20:40:27 -0700 |
| parents | 796f54d4ddbf |
| children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-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{hui} =} uibuttongroup () ## @deftypefnx {} {@var{hui} =} uibuttongroup (@var{property}, @var{value}, @dots{}) ## @deftypefnx {} {@var{hui} =} uibuttongroup (@var{parent}) ## @deftypefnx {} {@var{hui} =} uibuttongroup (@var{parent}, @var{property}, @var{value}, @dots{}) ## @c FIXME: 3rd form is not documented by Matlab nor implemented in Octave. ## @c Should it be removed? (1/9/2022). ## @deftypefnx {} {} uibuttongroup (@var{h}) ## ## Create a uibuttongroup object and return a handle to it. ## ## A uibuttongroup is used to group uicontrol objects. ## ## If @var{parent} is omitted then a uibuttongroup for the current figure is ## created. If no figure is available, a new figure is created first. ## ## If @var{parent} is given then a uibuttongroup relative to @var{parent} is ## created. ## ## Any provided property value pairs will override the default values of the ## created uibuttongroup object. ## ## The full list of properties is documented at @ref{Uibuttongroup Properties}. ## ## Examples: ## ## @example ## @group ## ## Create figure and panel on it ## f = figure; ## ## Create a button group ## gp = uibuttongroup (f, "Position", [ 0 0.5 1 1]) ## ## Create a buttons in the group ## b1 = uicontrol (gp, "style", "radiobutton", ... ## "string", "Choice 1", ... ## "Position", [ 10 150 100 50 ]); ## b2 = uicontrol (gp, "style", "radiobutton", ... ## "string", "Choice 2", ... ## "Position", [ 10 50 100 30 ]); ## ## Create a button not in the group ## b3 = uicontrol (f, "style", "radiobutton", ... ## "string", "Not in the group", ... ## "Position", [ 10 50 100 50 ]); ## @end group ## @end example ## ## When called with a single argument @var{h} which is a handle to an existing ## uibuttongroup object, switch the focus to the specified uibuttongroup. This ## functionality is not currently implemented. ## @seealso{figure, uipanel} ## @end deftypefn function hui = uibuttongroup (varargin) if (nargin == 1 && isgraphics (varargin{1}, "uibuttongroup")) warning ("uibuttongroup: focusing not implemented yet"); return; endif [h, args] = __uiobject_split_args__ ("uibuttongroup", varargin, {"figure", "uipanel", "uibuttongroup"}); hui = __go_uibuttongroup__ (h, args{:}); endfunction %!demo %! f = clf (); %! gp = uibuttongroup (f, "position", [0 0.5 1 0.5], ... %! "selectionchangedfcn", ... %! @(h, e) fprintf ("Selection changed: %s\n", get (e.NewValue, "string"))); %! b1 = uicontrol (gp, "style", "radiobutton", ... %! "string", "Choice 1", ... %! "units", "normalized", ... %! "position", [0.01 0.5 0.98 0.5]); %! b2 = uicontrol (gp, "style", "radiobutton", ... %! "string", "Choice 2", ... %! "units", "normalized", ... %! "position", [0.01 0 0.98 0.5]); %! b3 = uicontrol (f, "style", "radiobutton", ... %! "string", "Not in the group", ... %! "units", "normalized", ... %! "position", [ 0.01 0 0.98 0.5 ]); %! fprintf ("Current selected: %s\n", get (get (gp, "selectedobject"), "string")); %! pause (0.5); %! disp ("Select b2"); %! set (gp, "selectedobject", b2); %! fprintf ("Current selected: %s\n", get (get (gp, "selectedobject"), "string")); %! pause (0.5); %! disp ("Select None"); %! set (gp, "selectedobject", []); %! pause (0.1); %! fprintf ("Current selected: %s\n", get (get (gp, "selectedobject"), "string")); ## Test mutual selection logic for radiobuttons ## FIXME: commented out until a test can be found that doesn't rely on ## long values for pause() which still can occasionally fail. %!#test <*55230> %! hf = figure ("visible", "off"); %! unwind_protect %! bg = uibuttongroup (hf); %! b1 = uicontrol (bg, "style", "radiobutton", "units", "normalized", ... %! "position", [0, 0, 1, 0.5]); %! b2 = uicontrol (bg, "style", "radiobutton", "units", "normalized", ... %! "position", [0, 0.5, 1, 0.5]); %! assert (get (bg, "selectedobject"), b1); %! assert (get (b1, "value"), 1); %! assert (get (b2, "value"), 0); %! ## select radiobutton 2 %! set (bg, "selectedobject", b2); %! pause (0.5); %! assert (get (b1, "value"), 0); %! assert (get (b2, "value"), 1); %! ## set radiobutton 1 %! set (b1, "value", 1); %! pause (0.5); %! assert (get (bg, "selectedobject"), b1); %! assert (get (b1, "value"), 1); %! assert (get (b2, "value"), 0); %! ## unset all radiobuttons %! set (bg, "selectedobject", []); %! pause (0.5); %! assert (get (b1, "value"), 0); %! assert (get (b2, "value"), 0); %! ## change style of selected button %! set (b1, "value", 1); %! pause (0.5); %! assert (get (bg, "selectedobject"), b1); %! set (b1, "style", "pushbutton"); %! pause (0.5); %! assert (get (bg, "selectedobject"), []); %! ## add new button %! b3 = uicontrol (bg, "style", "togglebutton"); %! pause (0.5); %! assert (get (bg, "selectedobject"), b3); %! assert (get (b2, "value"), 0); %! assert (get (b3, "value"), 1); %! ## remove selected button %! delete (b3); %! pause (0.5); %! assert (get (bg, "selectedobject"), []); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## Test mutual selection logic for togglebuttons ## FIXME: commented out until a test can be found that doesn't rely on ## long values for pause() which still can occasionally fail. %!#test <*55230> %! hf = figure ("visible", "off"); %! unwind_protect %! bg = uibuttongroup (hf); %! b1 = uicontrol (bg, "style", "togglebutton", "units", "normalized", ... %! "position", [0, 0, 1, 0.5]); %! b2 = uicontrol (bg, "style", "togglebutton", "units", "normalized", ... %! "position", [0, 0.5, 1, 0.5]); %! assert (get (bg, "selectedobject"), b1); %! assert (get (b1, "value"), 1); %! assert (get (b2, "value"), 0); %! ## select togglebutton 2 %! set (bg, "selectedobject", b2); %! pause (0.5); %! assert (get (b1, "value"), 0); %! assert (get (b2, "value"), 1); %! ## set togglebutton 1 %! set (b1, "value", 1); %! pause (0.5); %! assert (get (bg, "selectedobject"), b1); %! assert (get (b1, "value"), 1); %! assert (get (b2, "value"), 0); %! ## unset all togglebuttons %! set (bg, "selectedobject", []); %! pause (0.5); %! assert (get (b1, "value"), 0); %! assert (get (b2, "value"), 0); %! ## change style of selected button %! set (b1, "value", 1); %! pause (0.5); %! assert (get (bg, "selectedobject"), b1); %! set (b1, "style", "pushbutton"); %! assert (get (bg, "selectedobject"), []); %! ## add new button %! b3 = uicontrol (bg, "style", "togglebutton"); %! pause (0.5); %! assert (get (bg, "selectedobject"), b3); %! assert (get (b2, "value"), 0); %! assert (get (b3, "value"), 1); %! ## remove selected button %! delete (b3); %! pause (0.5); %! assert (get (bg, "selectedobject"), []); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect