Mercurial > hg > octave-nkf
diff scripts/gui/uipanel.m @ 20808:7890893a0e69 stable
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 |
line wrap: on
line diff
--- a/scripts/gui/uipanel.m +++ b/scripts/gui/uipanel.m @@ -17,8 +17,36 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{hui} =} uipanel ("Name", value, @dots{}) -## @deftypefnx {Function File} {@var{hui} =} uipanel (@var{parent}, "Name", value, @dots{}) +## @deftypefn {Function File} {@var{hui} =} uipanel (@var{property}, @var{value}, @dots{}) +## @deftypefnx {Function File} {@var{hui} =} uipanel (@var{parent}, "@var{property}, @var{value}, @dots{}) +## +## Create a uipanel object and return a handle to it. +## +## uipanels are used as containers to group other uicontrol objects. +## +## If @var{parent} is omitted then a uipanel for the current figure is +## created. If no figure is available, a new figure is created first. +## +## If @var{parent} is given then a uipanel relative to @var{parent} is created. +## +## Any provided property value pairs will override the default values of the created +## uipanel object. +## +## Examples: +## +## @example +## @group +## % create figure and panel on it +## f = figure; +## p = uipanel ("title", "Panel Title", "position", [.25 .25 .5 .5]); +## +## % add two buttons to the panel +## b1 = uicontrol ("parent", p, "string", "A Button", "position",[18 10 150 36]); +## b2 = uicontrol ("parent", p, "string", "Another Button", "position",[18 60 150 36]); +## +## @end group +## @end example +## @seealso{figure, uicontrol} ## @end deftypefn ## Author: goffioul