Mercurial > hg > octave-lyh

comparison scripts/plot/uigetfile.m @ 11563:3c6e8aaa9555

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck m-files before 3.4 release.
author Rik <octave@nomad.inbox5.com>
date Tue, 18 Jan 2011 20:55:01 -0800
parents fd0a3ac60b0e
children 8ac9687dbe9f
comparison
equal deleted inserted replaced
11562:1811f4f8b3b5 11563:3c6e8aaa9555
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{fname}, @var{fpath}, @var{fltidx}] =} uigetfile (@var{flt}) 20 ## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uigetfile (@var{flt})
21 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}, @var{default_file}) 21 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}, @var{default_file})
22 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}) 22 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name})
23 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{},"Position",[@var{px}, @var{py}]) 23 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "Position", [@var{px}, @var{py}])
24 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{},"Multiselect",@var{mode}) 24 ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "Multiselect", @var{mode})
25 ## 25 ##
26 ## Open a GUI dialog to select a file. It returns the filename @var{fname}, 26 ## Open a GUI dialog to select a file. It returns the filename @var{fname},
27 ## the path to this file @var{fpath} and the filter index @var{fltidx}. 27 ## the path to this file @var{fpath}, and the filter index @var{fltidx}.
28 ## @var{flt} contains a (list of) file filter string(s) in one of the following 28 ## @var{flt} contains a (list of) file filter string(s) in one of the following
29 ## formats: 29 ## formats:
30 ## 30 ##
31 ## @table @code 31 ## @table @asis
32 ## @item "/path/to/filename.ext" 32 ## @item "/path/to/filename.ext"
33 ## If a filename is given the file extension is extracted and used as filter. 33 ## If a filename is given the file extension is extracted and used as filter.
34 ## In addtion the path is selected as current path and the filname is selected 34 ## In addtion the path is selected as current path and the filname is selected
35 ## as default file. 35 ## as default file.
36 ## Example: uigetfile("myfun.m"); 36 ## Example: @code{uigetfile ("myfun.m")}
37 ## 37 ##
38 ## @item A single file extension "*.ext". 38 ## @item A single file extension "*.ext"
39 ## Example: uigetfile("*.ext"); 39 ## Example: @code{uigetfile ("*.ext")}
40 ## 40 ##
41 ## @item A 2-column cell array, 41 ## @item A 2-column cell array
42 ## containing the file extension in the 1st column and a brief description 42 ## containing the file extension in the first column and a brief description
43 ## in the 2nd column. 43 ## in the second column.
44 ## Example: uigetfile(@{"*.ext","My Description";"*.xyz","XYZ-Format"@}); 44 ## Example: @code{uigetfile (@{"*.ext", "My Description";"*.xyz",
45 ## "XYZ-Format"@})}
45 ## 46 ##
46 ## The filter string can also contain a semicolon separated list of filter 47 ## The filter string can also contain a semicolon separated list of filter
47 ## extensions. 48 ## extensions.
48 ## Example: uigetfile(@{"*.gif;*.png;*.jpg", "Supported Picture Formats"@}); 49 ## Example: @code{uigetfile (@{"*.gif;*.png;*.jpg", "Supported Picture
50 ## Formats"@})}
49 ## @end table 51 ## @end table
50 ## 52 ##
51 ## @var{dialog_name} can be used to customize the dialog title. 53 ## @var{dialog_name} can be used to customize the dialog title.
52 ## If @var{default_file} is given it is selected in the GUI dialog. 54 ## If @var{default_file} is given it is selected in the GUI dialog.
53 ## If in addtion a path is given it is also used as current path. 55 ## If in addtion a path is given it is also used as current path.
54 ## 56 ##
55 ## The screen position of the GUI dialog can be set by using the "Position" key 57 ## The screen position of the GUI dialog can be set using the "Position" key
56 ## and a 2-valued vector containing the pixel coordinates. 58 ## and a 2-element vector containing the pixel coordinates.
57 ## Two or more files can be selected when setting the "Multiselect" key to "on". 59 ## Two or more files can be selected when setting the "Multiselect" key to "on".
58 ## In that case @var{fname} is a cell array containing the files. 60 ## In that case @var{fname} is a cell array containing the files.
59 ## @end deftypefn 61 ## @end deftypefn
60 62
61 ## Author: Kai Habel 63 ## Author: Kai Habel