Mercurial > octave-nkf
annotate scripts/plot/uimenu.m @ 13703:22ce748da25f
Add missing UI objects: uicontextmenu, uitoolbar, uipushtool and uitoggletool.
* graphics.h.in (uicontextmenu, uitoolbar, uipushtool, uitoggletool): New
graphic object classes.
(uicontrol::properties::cdata): Allow "single" and "uint8" data.
* graphics.cc (uitoolbar): New class implementation.
* gl-render.cc (opengl_renderer::draw): Skip new object types.
* plot/private/__uiobject_split_args__.m: Don't use varargin. Add parent_type
and use_gcf arguments. Check that number of arguments is a multiple of 2.
* plot/uicontrol.m: Adapt call to __uiobject_split_args__.
* plot/uipanel.m: Likewise.
* plot/uimenu.m: Rewrite to use __uiobject_split_args__.
* plot/uicontextmenu.m: New file.
* plot/uitoolbar.m: Likewise.
* plot/uipushtool.m: Likewise.
* plot/uitoggletool.m: Likewise.
* plot/modules.mk (plot_FCN_FILES): Add uicontextmenu.m, uitoolbar.m,
uipushtool.m and uitoggletool.m.
| author | Michael Goffioul <michael.goffioul@gmail.com> |
|---|---|
| date | Fri, 14 Oct 2011 23:19:06 +0100 |
| parents | 931d4b7dc205 |
| children | 08ae07e40d4f |
| rev | line source |
|---|---|
| 11523 | 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{}) |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11595
diff
changeset
|
22 ## Create a uimenu object and return a handle to it. If @var{h} is ommited |
|
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11595
diff
changeset
|
23 ## then a top-level menu for the current figure is created. If @var{h} |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
24 ## is given then a submenu relative to @var{h} is created. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
25 ## |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11595
diff
changeset
|
26 ## uimenu objects have the following specific properties: |
|
11155
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
27 ## |
|
11595
5ec6aa05638d
Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
28 ## @table @asis |
|
11155
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
29 ## @item "accelerator" |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11595
diff
changeset
|
30 ## A string containing the key combination together with CTRL to execute this |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
31 ## menu entry (e.g., "x" for CTRL+x). |
|
11155
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" |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
34 ## Is the function called when this menu entry is executed. It can be either a |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
35 ## function string (e.g., "myfun"), a function handle (e.g., @@myfun) or a cell |
|
11155
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 |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
37 ## function (e.g., @{@@myfun, arg1, arg2@}). |
|
11155
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" |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
40 ## Can be set "on" or "off". Sets a mark at this menu entry. |
|
11155
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" |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
43 ## Can be set "on" or "off". If disabled the menu entry cannot be selected |
|
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
44 ## and it is grayed out. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
45 ## |
|
11155
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" |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
50 ## A string containing the label for this menu entry. A "&"-symbol can be |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11595
diff
changeset
|
51 ## used to mark the "accelerator" character (e.g., @nospell{"E&xit"}) |
|
11155
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" |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
54 ## An scalar value containing the relative menu position. The entry with the |
|
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
55 ## lowest value is at the first position starting from left or top. |
|
11155
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" |
|
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
58 ## Can be set "on" or "off". If enabled it draws a separator line above the |
|
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
59 ## current position. It is ignored for top level entries. |
|
11155
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 ## @end table |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
62 ## |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
63 ## Examples: |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
64 ## |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
65 ## @example |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
66 ## @group |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
67 ## f = uimenu("label", "&File", "accelerator", "f"); |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
68 ## e = uimenu("label", "&Edit", "accelerator", "e"); |
|
12974
6590446c2498
doc: Correct Texinfo overfull hbox instances.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
69 ## uimenu(f, "label", "Close", "accelerator", "q", ... |
|
6590446c2498
doc: Correct Texinfo overfull hbox instances.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
70 ## "callback", "close (gcf)"); |
|
6590446c2498
doc: Correct Texinfo overfull hbox instances.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
71 ## uimenu(e, "label", "Toggle &Grid", "accelerator", "g", ... |
|
6590446c2498
doc: Correct Texinfo overfull hbox instances.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
72 ## "callback", "grid (gca)"); |
|
11155
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
73 ## @end group |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
74 ## @end example |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
75 ## @seealso{figure} |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
76 ## @end deftypefn |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
77 |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
78 ## Author: Kai Habel |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
79 |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
80 function hui = uimenu (varargin) |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
81 |
|
13703
22ce748da25f
Add missing UI objects: uicontextmenu, uitoolbar, uipushtool and uitoggletool.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
13223
diff
changeset
|
82 [h, args] = __uiobject_split_args__ ("uimenu", varargin, {"figure", "uicontextmenu", "uimenu"}); |
|
11295
75ff3db6a687
Simplify code for uimenu.m. Fix error messages for ui file functions.
Kai Habel <kai.habel@gmx.de>
parents:
11159
diff
changeset
|
83 |
|
11155
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
84 tmp = __go_uimenu__ (h, args{:}); |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
85 |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
86 if (nargout > 0) |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
87 hui = tmp; |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
88 endif |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
89 |
|
f0e9befd6a1c
add uimenu graphic object to fltk backend
Kai Habel <kai.habel@gmx.de>
parents:
diff
changeset
|
90 endfunction |
| 11159 | 91 |
| 92 %!demo | |
| 93 %! surfl(peaks); | |
| 94 %! colormap(copper); | |
| 95 %! shading("interp"); | |
| 96 %! f = uimenu("label", "&File", "accelerator", "f"); | |
| 97 %! e = uimenu("label", "&Edit", "accelerator", "e"); | |
| 98 %! uimenu(f, "label", "Close", "accelerator", "q", "callback", "close (gcf)"); | |
| 99 %! uimenu(e, "label", "Toggle &Grid", "accelerator", "g", "callback", "grid (gca)"); | |
| 13215 | 100 |
| 101 %!test | |
| 102 %! hf = figure ("visible", "off"); | |
| 103 %! unwind_protect | |
| 104 %! ui = uimenu ("label", "mylabel"); | |
| 105 %! assert (findobj (hf, "type", "uimenu"), ui); | |
| 106 %! assert (get (ui, "label"), "mylabel"); | |
| 107 %! assert (get (ui, "checked"), "off"); | |
| 108 %! assert (get (ui, "separator"), "off"); | |
| 109 %! assert (get (ui, "enable"), "on"); | |
| 110 %! assert (get (ui, "position"), 9); | |
| 111 %! unwind_protect_cleanup | |
| 112 %! close (hf); | |
| 113 %! end_unwind_protect | |
| 114 | |
| 115 %% check for top level menus file, edit, and help | |
| 116 %!test | |
| 117 %! hf = figure ("visible", "off"); | |
| 118 %! unwind_protect | |
| 119 %! uif = findall (hf, "label", "&file"); | |
| 120 %! assert (ishghandle (uif)) | |
| 121 %! uie = findall (hf, "label", "&edit"); | |
| 122 %! assert (ishghandle (uie)) | |
| 123 %! uih = findall (hf, "label", "&help"); | |
| 124 %! assert (ishghandle (uih)) | |
| 125 %! unwind_protect_cleanup | |
| 126 %! close (hf); | |
| 127 %! end_unwind_protect | |
| 128 | |
| 129 %!test | |
| 130 %! hf = figure ("visible", "off"); | |
| 131 %! unwind_protect | |
| 13223 | 132 %! uie = findall (hf, "label", "&edit"); |
| 13215 | 133 %! myui = uimenu (uie, "label", "mylabel"); |
| 134 %! assert (ancestor (myui, "uimenu", "toplevel"), uie) | |
| 135 %! unwind_protect_cleanup | |
| 136 %! close (hf); | |
| 137 %! end_unwind_protect |