Mercurial > octave-nkf

comparison scripts/gui/uipanel.m @ 20632:7890893a0e69 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add uiXXXX documentation (Bug #46076) * scripts/gui/uicontextmenu.m: add function documentation. * scripts/gui/uitoolbar.m: add function documentation. * scripts/gui/uitoggletool.m: add function documentation. * scripts/gui/uipushtool.m: add function documentation. * scripts/gui/uipanel.m: add function documentation. * scripts/gui/uicontrol.m: add function documentation.
author John Donoghue <john.donoghue@ieee.org>
date Thu, 08 Oct 2015 20:59:25 -0400
parents 9fc020886ae9
children 93d96da9ff3e
comparison
equal deleted inserted replaced
20625:45759620a9a5 20632:7890893a0e69
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{hui} =} uipanel ("Name", value, @dots{}) 20 ## @deftypefn {Function File} {@var{hui} =} uipanel (@var{property}, @var{value}, @dots{})
21 ## @deftypefnx {Function File} {@var{hui} =} uipanel (@var{parent}, "Name", value, @dots{}) 21 ## @deftypefnx {Function File} {@var{hui} =} uipanel (@var{parent}, "@var{property}, @var{value}, @dots{})
22 ##
23 ## Create a uipanel object and return a handle to it.
24 ##
25 ## uipanels are used as containers to group other uicontrol objects.
26 ##
27 ## If @var{parent} is omitted then a uipanel for the current figure is
28 ## created. If no figure is available, a new figure is created first.
29 ##
30 ## If @var{parent} is given then a uipanel relative to @var{parent} is created.
31 ##
32 ## Any provided property value pairs will override the default values of the created
33 ## uipanel object.
34 ##
35 ## Examples:
36 ##
37 ## @example
38 ## @group
39 ## % create figure and panel on it
40 ## f = figure;
41 ## p = uipanel ("title", "Panel Title", "position", [.25 .25 .5 .5]);
42 ##
43 ## % add two buttons to the panel
44 ## b1 = uicontrol ("parent", p, "string", "A Button", "position",[18 10 150 36]);
45 ## b2 = uicontrol ("parent", p, "string", "Another Button", "position",[18 60 150 36]);
46 ##
47 ## @end group
48 ## @end example
49 ## @seealso{figure, uicontrol}
22 ## @end deftypefn 50 ## @end deftypefn
23 51
24 ## Author: goffioul 52 ## Author: goffioul
25 53
26 function hui = uipanel (varargin) 54 function hui = uipanel (varargin)