Mercurial > octave
annotate scripts/gui/uipanel.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 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
3 ## Copyright (C) 2012-2022 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26877
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
7 ## |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
8 ## This file is part of Octave. |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
9 ## |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23396
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
11 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23396
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
14 ## |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
15 ## Octave is distributed in the hope that it will be useful, but |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
19 ## |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
20 ## You should have received a copy of the GNU General Public License |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
21 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23396
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
25 |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
26 ## -*- texinfo -*- |
30875
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
27 ## @deftypefn {} {@var{hui} =} uipanel () |
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
28 ## @deftypefnx {} {@var{hui} =} uipanel (@var{property}, @var{value}, @dots{}) |
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
29 ## @deftypefnx {} {@var{hui} =} uipanel (@var{parent}) |
5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
30 ## @deftypefnx {} {@var{hui} =} uipanel (@var{parent}, @var{property}, @var{value}, @dots{}) |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
31 ## |
23271
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
32 ## Create a uipanel object. |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
33 ## |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
34 ## uipanels are used as containers to group other uicontrol objects. |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
35 ## |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
36 ## If @var{parent} is omitted then a uipanel for the current figure is |
20716
1ecee53513d7
doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
37 ## created. If no figure is available, a new figure is created first. |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
38 ## |
20715
5b7643257978
Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents:
20615
diff
changeset
|
39 ## If @var{parent} is given then a uipanel relative to @var{parent} is created. |
5b7643257978
Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents:
20615
diff
changeset
|
40 ## |
20716
1ecee53513d7
doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
41 ## Any provided property value pairs will override the default values of the |
1ecee53513d7
doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
42 ## created uipanel object. |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
43 ## |
26877
83774c2a1b92
doc: Place cross-reference from list of graphics object properties back to object (bug #46076).
Rik <rik@octave.org>
parents:
26577
diff
changeset
|
44 ## The full list of properties is documented at @ref{Uipanel Properties}. |
20615
93d96da9ff3e
Update uiXXXXX documentation for autogenerated properties
John Donoghue
parents:
20597
diff
changeset
|
45 ## |
23271
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
46 ## The optional return value @var{hui} is a graphics handle to the created |
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
47 ## uipanel object. |
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
48 ## |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
49 ## Examples: |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
50 ## |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
51 ## @example |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
52 ## @group |
26577
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
53 ## ## create figure and panel on it |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
54 ## f = figure; |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
55 ## p = uipanel ("title", "Panel Title", "position", [.25 .25 .5 .5]); |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
56 ## |
26577
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
57 ## ## add two buttons to the panel |
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
58 ## b1 = uicontrol ("parent", p, "string", "A Button", ... |
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
59 ## "position", [18 10 150 36]); |
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
60 ## b2 = uicontrol ("parent", p, "string", "Another Button", ... |
ae1542fb58ba
documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents:
26376
diff
changeset
|
61 ## "position",[18 60 150 36]); |
20597
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
62 ## |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
63 ## @end group |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
64 ## @end example |
7890893a0e69
Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents:
19833
diff
changeset
|
65 ## @seealso{figure, uicontrol} |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
66 ## @end deftypefn |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
67 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
68 function hui = uipanel (varargin) |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
69 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
70 [h, args] = __uiobject_split_args__ ("uipanel", varargin, |
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
71 {"figure", "uipanel", "uibuttongroup"}); |
23271
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
72 htmp = __go_uipanel__ (h, args{:}); |
23396
945b53af4655
maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents:
23271
diff
changeset
|
73 |
23271
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
74 if (nargout > 0) |
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
75 hui = htmp; |
cc9dcadcef6b
Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
76 endif |
13284
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
77 |
5ab9c721ce59
Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff
changeset
|
78 endfunction |