Mercurial > octave-nkf

comparison scripts/gui/uitoolbar.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} =} uitoolbar ("Name", value, @dots{}) 20 ## @deftypefn {Function File} {@var{hui} =} uitoolbar (@var{property}, @var{value}, @dots{})
21 ## @deftypefnx {Function File} {@var{hui} =} uitoolbar (@var{parent}, "Name", value, @dots{}) 21 ## @deftypefnx {Function File} {@var{hui} =} uitoolbar (@var{parent}, @var{property}, @var{value}, @dots{})
22 ##
23 ## Create a uitoolbar object and return a handle to it. A uitoolbar displays uitoggletool and uipushtool buttons.
24 ##
25 ## If @var{parent} is omitted then a uitoolbar for the current figure is
26 ## created. If no figure is available, a new figure is created first.
27 ##
28 ## If @var{parent} is given then a uitoolbar relative to @var{parent} is created.
29 ##
30 ## Any provided property value pairs will override the default values of the created
31 ## uitoolbar object.
32 ##
33 ## Examples:
34 ##
35 ## @example
36 ## @group
37 ## % create figure without a default toolbar
38 ## f = figure ("toolbar", "none");
39 ## % create empty toolbar
40 ## t = uitoolbar (f);
41 ## @end group
42 ## @end example
43 ## @seealso{figure, uitoggletool, uipushtool}
22 ## @end deftypefn 44 ## @end deftypefn
23 45
24 ## Author: goffioul 46 ## Author: goffioul
25 47
26 function hui = uitoolbar (varargin) 48 function hui = uitoolbar (varargin)