Mercurial > octave-nkf
diff scripts/gui/uitoggletool.m @ 20632: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/uitoggletool.m Fri Oct 09 19:14:20 2015 -0700 +++ b/scripts/gui/uitoggletool.m Thu Oct 08 20:59:25 2015 -0400 @@ -17,8 +17,38 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{hui} =} uitoggletool ("Name", value, @dots{}) -## @deftypefnx {Function File} {@var{hui} =} uitoggletool (@var{parent}, "Name", value, @dots{}) +## @deftypefn {Function File} {@var{hui} =} uitoggletool (@var{property}, @var{value}, @dots{}) +## @deftypefnx {Function File} {@var{hui} =} uitoggletool (@var{parent}, @var{property}, @var{value}, @dots{}) +## +## Create a uitoggletool object and return a handle to it. +## +## uitoggletool are togglebuttons that appear on a figure toolbar. The button is created with a border that +## is shown when the user hovers over the button. An image can be set using the cdata property. +## +## If @var{parent} is omitted then a uitoggletool for the current figure is +## created. If no figure is available, a new figure is created first. If a figure is +## available, but does not contain a uitoolbar, a uitoolbar will be created. +## +## If @var{parent} is given then a uitoggletool is created on the @var{parent} uitoolbar. +## +## Any provided property value pairs will override the default values of the created +## uitoggletool object. +## +## Examples: +## +## @example +## @group +## % create figure without a default toolbar +## f = figure ("toolbar", "none"); +## % create empty toolbar +## t = uitoolbar (f); +## % create a 19x19x3 black square +## img=zeros(19,19,3); +## % add uitoggletool button to toolbar +## b = uitoggletool (t, "cdata", img); +## @end group +## @end example +## @seealso{figure, uitoolbar, uipushtool} ## @end deftypefn ## Author: goffioul