Mercurial > hg > octave-lyh

annotate scripts/plot/uimenu.m @ 11540:b0ef6f28e09a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
deprecate krylovb function
author John W. Eaton <jwe@octave.org>
date Sat, 15 Jan 2011 03:40:32 -0500
parents fd0a3ac60b0e
children 3c6e8aaa9555
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11472
diff changeset
1 ## Copyright (C) 2010-2011 Kai Habel
11155
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
2 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
3 ## This file is part of Octave.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
4 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
8 ## your option) any later version.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
9 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
13 ## General Public License for more details.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
14 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
18
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
19 ## -*- texinfo -*-
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
20 ## @deftypefn {Function File} {} uimenu (@var{property}, @var{value}, @dots{})
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} uimenu (@var{h}, @var{property}, @var{value}, @dots{})
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
22 ## Create an uimenu object and return a handle to it. If @var{h} is ommited then
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
23 ## a top level menu entry for the current figure is created. If @var{h} is given then a
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
24 ## submenu relative to @var{h} is created.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
25 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
26 ## Uimenu objects have the following specific properties:
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
27 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
28 ## @table @code
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
29 ## @item "accelerator"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
30 ## A string containg the key combination together with CTRL to execute this
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
31 ## menu entry (e.g. "x" for CTRL+x).
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
32 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
33 ## @item "callback"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
34 ## Is the function called when this menu entry is executed. It can be either a
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
35 ## function string (e.g. "myfun"), a function handle (e.g. @@myfun) or a cell
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
36 ## array containing the function handle and arguments for the callback
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
37 ## function (e.g. @{@@myfun, arg1, arg2@}).
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
38 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
39 ## @item "checked"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
40 ## Can be set "on" or "off". Sets a mark at this menu entry.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
41 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
42 ## @item "enable"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
43 ## Can be set "on" or "off". If disabled the menu entry cannot be selected and it is
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
44 ## grayed out.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
45 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
46 ## @item "foregroundcolor"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
47 ## A color value setting the text color for this menu entry.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
48 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
49 ## @item "label"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
50 ## A string containing the label for this menu entry. A "&"-symbol can be used to mark
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
51 ## the "accelerator" character (e.g. "E&xit")
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
52 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
53 ## @item "position"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
54 ## An scalar value containing the relative menu position. The entry with the lowest
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
55 ## value is at the first position starting from left or top.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
56 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
57 ## @item "separator"
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
58 ## Can be set "on" or "off". If enabled it draws a separator line above the current
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
59 ## position. It is ignored for top level entries.
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
60 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
61 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
62 ## @end table
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
63 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
64 ## Examples:
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
65 ##
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
66 ## @example
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
67 ## @group
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
68 ## f = uimenu("label", "&File", "accelerator", "f");
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
69 ## e = uimenu("label", "&Edit", "accelerator", "e");
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
70 ## uimenu(f, "label", "Close", "accelerator", "q", "callback", "close (gcf)");
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
71 ## uimenu(e, "label", "Toggle &Grid", "accelerator", "g", "callback", "grid (gca)");
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
72 ## @end group
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
73 ## @end example
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
74 ## @seealso{figure}
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
75 ## @end deftypefn
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
76
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
77 ## Author: Kai Habel
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
78
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
79 function hui = uimenu (varargin)
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
80
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
81 args = varargin;
11295
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
82
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
83 if (ishandle (args{1}))
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
84 h = args{1};
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
85 args(1) = [];
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
86 else
11155
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
87 h = gcf ();
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
88 endif
11295
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
89
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
90 if (rem (length (args), 2))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11295
diff changeset
91 error ("uimenu: expecting PROPERTY/VALUE pairs");
11295
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
92 endif
75ff3db6a687 Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents: 11159
diff changeset
93
11155
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
94 tmp = __go_uimenu__ (h, args{:});
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
95
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
96 if (nargout > 0)
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
97 hui = tmp;
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
98 endif
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
99
f0e9befd6a1c add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
100 endfunction
11159
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
101
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
102 %!demo
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
103 %! surfl(peaks);
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
104 %! colormap(copper);
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
105 %! shading("interp");
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
106 %! f = uimenu("label", "&File", "accelerator", "f");
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
107 %! e = uimenu("label", "&Edit", "accelerator", "e");
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
108 %! uimenu(f, "label", "Close", "accelerator", "q", "callback", "close (gcf)");
a06759adaa79 Add demo for uimenu.m
Kai Habel <kai.habel@gmx.de>
parents: 11155
diff changeset
109 %! uimenu(e, "label", "Toggle &Grid", "accelerator", "g", "callback", "grid (gca)");