Mercurial > octave-nkf
view scripts/ui/listdlg.m @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | e39f00a32dc7 |
children |
line wrap: on
line source
## Copyright (C) 2010 Martin Hepperle ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{sel}, @var{ok}] =} listdlg (@var{key}, @var{value}, @dots{}) ## Return user inputs from a list dialog box in a vector of ## selection indices @var{sel} and a flag @var{ok} indicating how the ## user closed the dialog box. The value of @var{ok} is 1 if the user ## closed the box with the OK button, otherwise it is 0 and @var{sel} is ## empty. ## ## The indices in @var{sel} are 1-based. ## ## The arguments are specified in form of @var{key}, @var{value} pairs. ## The @qcode{"ListString"} argument pair must be specified. ## ## Valid @var{key} and @var{value} pairs are: ## ## @table @asis ## @item @qcode{"ListString"} ## a cell array of strings comprising the content of the list. ## ## @item @qcode{"SelectionMode"} ## can be either @qcode{"Single"} or @qcode{"Multiple"} (default). ## ## @item @qcode{"ListSize"} ## a vector with two elements @var{width} and @var{height} defining ## the size of the list field in pixels. Default is [160 300]. ## ## @item @qcode{"InitialValue"} ## a vector containing 1-based indices of preselected elements. Default ## is 1 (first item). ## ## @item @qcode{"Name"} ## a string to be used as the dialog caption. Default is "". ## ## @item @qcode{"PromptString"} ## a cell array of strings to be displayed above the list field. Default ## is @{@}. ## ## @item @qcode{"OKString"} ## a string used to label the OK button. Default is @qcode{"OK"}. ## ## @item @qcode{"CancelString"} ## a string used to label the Cancel button. Default is @qcode{"Cancel"}. ## @end table ## ## Example: ## ## @example ## @group ## [sel, ok] = listdlg ("ListString", @{"An item", "another", "yet another"@}, ## "SelectionMode", "Multiple"); ## if (ok == 1) ## for i = 1:numel (sel) ## disp (sel(i)); ## endfor ## endif ## @end group ## @end example ## ## @seealso{errordlg, helpdlg, inputdlg, msgbox, questdlg, warndlg} ## @end deftypefn function [sel, ok] = listdlg (varargin) if (nargin < 2) print_usage (); endif listcell = {""}; selmode = "Multiple"; listsize = [160, 300]; initialvalue = 1; name = ""; prompt = {}; okstring = "OK"; cancelstring = "Cancel"; ## handle key, value pairs for i = 1:2:nargin-1 if (strcmp (varargin{i}, "ListString")) listcell = varargin{i+1}; elseif (strcmp (varargin{i}, "SelectionMode")) selmode = varargin{i+1}; elseif (strcmp (varargin{i}, "ListSize")) listsize = varargin{i+1}; elseif (strcmp (varargin{i}, "InitialValue")) initialvalue = varargin{i+1}; elseif (strcmp (varargin{i}, "Name")) name = varargin{i+1}; elseif (strcmp (varargin{i}, "PromptString")) prompt = varargin{i+1}; elseif (strcmp (varargin{i}, "OKString")) okstring = varargin{i+1}; elseif (strcmp (varargin{i}, "CancelString")) cancelstring = varargin{i+1}; endif endfor ## make sure prompt strings are a cell array if (! iscell (prompt)) prompt = {prompt}; endif ## make sure listcell strings are a cell array if (! iscell (listcell)) listcell = {listcell}; endif ## make sure valid selection mode if (! strcmp (selmode, "Multiple") && ! strcmp (selmode, "Single")) error ("invalid SelectionMode"); endif if (__octave_link_enabled__ ()) [sel, ok] = __octave_link_list_dialog__ (listcell, selmode, listsize, initialvalue, name, prompt, okstring, cancelstring); elseif (__have_feature__ ("JAVA")) ## transform matrices to cell arrays of strings ## swap width and height to correct calling format for JDialogBox listsize = {num2str(listsize(2)), num2str(listsize(1))}; initialvalue = arrayfun (@num2str, initialvalue, "UniformOutput", false); if (isempty (prompt)) prompt = {""}; endif ret = javaMethod ("listdlg", "org.octave.JDialogBox", listcell, selmode, listsize, initialvalue, name, prompt, okstring, cancelstring); if (numel (ret) > 0) sel = ret; ok = 1; else sel = {}; ok = 0; endif else error ("listdlg is not available in this version of Octave"); endif endfunction %!demo %! disp ('- test listdlg with selectionmode single. No caption, no prompt.'); %! itemlist = {'An item \\alpha', 'another', 'yet another'}; %! s = listdlg ('ListString',itemlist, 'SelectionMode','Single'); %! imax = numel (s); %! for i=1:1:imax %! disp (['Selected: ',num2str (i),': ', itemlist{s (i)}]); %! end %!demo %! disp ('- test listdlg with selectionmode and preselection. Has caption and two lines prompt.'); %! itemlist = {'An item \\alpha', 'another', 'yet another'}; %! s = listdlg ('ListString',itemlist, ... %! 'SelectionMode','Multiple', ... %! 'Name','Selection Dialog', ... %! 'InitialValue',[1,2,3,4], %! 'PromptString',{'Select <b>an</b> item...', '...or <b>multiple</b> items'} ); %! imax = numel (s); %! for i=1:1:imax %! disp (['Selected: ',num2str (i),': ', itemlist{s (i)}]); %! end %!demo %! disp ('- test listdlg with listsize.'); %! itemlist = {"Neutron","Electron","Quark","Proton","Neutrino"}; %! s = listdlg ("ListString",itemlist, %! "Name","Bits and Pieces", %! "ListSize",[200 75] ); %! imax = numel (s); %! for i=1:1:imax %! disp (['Selected: ',num2str (i),': ', itemlist{s (i)}]); %! end