Mercurial > octave
view scripts/gui/uimenu.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | 796f54d4ddbf |
children | fef2957c38ec |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2010-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{hui} =} uimenu (@var{property}, @var{value}, @dots{}) ## @deftypefnx {} {@var{hui} =} uimenu (@var{h}, @var{property}, @var{value}, @dots{}) ## Create a uimenu object and return a handle to it. ## ## If @var{h} is omitted then a top-level menu for the current figure is ## created. If @var{h} is given then a submenu relative to @var{h} is created. ## ## uimenu objects have the following specific properties: ## ## @table @asis ## @item @qcode{"accelerator"} ## A string containing the key combination together with CTRL to execute this ## menu entry (e.g., @qcode{"x"} for CTRL+x). ## ## @item @qcode{"callback"} ## Is the function called when this menu entry is executed. It can be either a ## function string (e.g., @qcode{"myfcn"}), a function handle (e.g., @@myfcn) ## or a cell array containing the function handle and arguments for the ## callback function (e.g., @{@@myfcn, arg1, arg2@}). ## ## @item @qcode{"checked"} ## Can be set @qcode{"on"} or @qcode{"off"}. Sets a mark at this menu entry. ## ## @item @qcode{"enable"} ## Can be set @qcode{"on"} or @qcode{"off"}. If disabled the menu entry ## cannot be selected and it is grayed out. ## ## @item @qcode{"foregroundcolor"} ## A color value setting the text color for this menu entry. ## ## @item @qcode{"label"} ## A string containing the label for this menu entry. A @qcode{"&"}-symbol ## can be used to mark the @qcode{"accelerator"} character (e.g., ## @nospell{@qcode{"E&xit"}}) ## ## @item @qcode{"position"} ## An scalar value containing the relative menu position. The entry with the ## lowest value is at the first position starting from left or top. ## ## @item @qcode{"separator"} ## Can be set @qcode{"on"} or @qcode{"off"}. If enabled it draws a separator ## line above the current position. It is ignored for top level entries. ## ## @end table ## ## The full list of properties is documented at @ref{Uimenu Properties}. ## ## Examples: ## ## @example ## @group ## f = uimenu ("label", "&File", "accelerator", "f"); ## e = uimenu ("label", "&Edit", "accelerator", "e"); ## uimenu (f, "label", "Close", "accelerator", "q", ... ## "callback", "close (gcf)"); ## uimenu (e, "label", "Toggle &Grid", "accelerator", "g", ... ## "callback", "grid (gca)"); ## @end group ## @end example ## @seealso{figure} ## @end deftypefn function hui = uimenu (varargin) [h, args] = __uiobject_split_args__ ("uimenu", varargin, {"figure", "uicontextmenu", "uimenu"}); tmp = __go_uimenu__ (h, args{:}); if (nargout > 0) hui = tmp; endif endfunction %!demo %! clf; %! surfl (peaks); %! colormap (copper (64)); %! shading ('interp'); %! f = uimenu ('label', '&File', 'accelerator', 'f'); %! e = uimenu ('label', '&Edit', 'accelerator', 'e'); %! uimenu (f, 'label', 'Close', 'accelerator', 'q', 'callback', 'close (gcf)'); %! uimenu (e, 'label', 'Toggle &Grid', 'accelerator', 'g', 'callback', 'grid (gca)'); %!testif HAVE_OPENGL, HAVE_QT; have_window_system () && any (strcmp ("qt", available_graphics_toolkits ())) %! toolkit = graphics_toolkit ("qt"); %! hf = figure ("visible", "off"); %! unwind_protect %! ui = uimenu ("label", "mylabel"); %! assert (findobj (hf, "type", "uimenu"), ui); %! assert (get (ui, "label"), "mylabel"); %! assert (get (ui, "checked"), "off"); %! assert (get (ui, "separator"), "off"); %! assert (get (ui, "enable"), "on"); %! assert (get (ui, "position"), 4); %! unwind_protect_cleanup %! close (hf); %! graphics_toolkit (toolkit); %! end_unwind_protect ## check for top level menus file and edit %!testif HAVE_OPENGL, HAVE_QT; have_window_system () && any (strcmp ("qt", available_graphics_toolkits ())) %! toolkit = graphics_toolkit ("qt"); %! hf = figure ("visible", "off"); %! unwind_protect %! uif = findall (hf, "label", "&file"); %! assert (ishghandle (uif)); %! uie = findall (hf, "label", "&edit"); %! assert (ishghandle (uie)); %! unwind_protect_cleanup %! close (hf); %! graphics_toolkit (toolkit); %! end_unwind_protect %!testif HAVE_OPENGL, HAVE_QT; have_window_system () && any (strcmp ("qt", available_graphics_toolkits ())) %! toolkit = graphics_toolkit ("qt"); %! hf = figure ("visible", "off"); %! unwind_protect %! uie = findall (hf, "label", "&edit"); %! myui = uimenu (uie, "label", "mylabel"); %! assert (ancestor (myui, "uimenu", "toplevel"), uie); %! unwind_protect_cleanup %! close (hf); %! graphics_toolkit (toolkit); %! end_unwind_protect