bugGNU Octave - Bugs: bug #57670, document uigetdir/uigetfile return...

 
 

bug #57670: document uigetdir/uigetfile return value when Cancel is hit

Submitter:  A.R. Burgers <arb>
Submitted:  Sun 26 Jan 2020 08:15:12 PM UTC
   
 
Category:  Octave Function Severity:  2 - Minor
Priority:  3 - Low Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Tue 28 Jan 2020 04:01:23 PM UTC, comment #1: 

I updated the documentation to describe the return value if the 'Cancel' button is used in this changeset https://hg.savannah.gnu.org/hgweb/octave/rev/306df6825dd9.

Marking as fixed and closing report.

Rik <rik5>
Group administrator
Sun 26 Jan 2020 08:15:12 PM UTC, original submission:  

the uigetdir/uigetfile documentation does not mention the return value in case the user hits the cancel button in the dialog, I suggest to add a line like this:


diff -r e6482c932d4b scripts/gui/uigetdir.m
--- a/scripts/gui/uigetdir.m    Sun Jan 26 17:00:05 2020 +0100
+++ b/scripts/gui/uigetdir.m    Sun Jan 26 21:08:25 2020 +0100
@@ -31,6 +31,8 @@
 ##
 ## If @var{init_path} is not given the current working directory is used.
 ##
+## If the user hits the Cancel button in the dialog, uigetdir returns a 0 of class double.
+##
 ## @var{dialog_name} may be used to customize the dialog title.
 ## @seealso{uigetfile, uiputfile}
 ## @end deftypefn
diff -r e6482c932d4b scripts/gui/uigetfile.m
--- a/scripts/gui/uigetfile.m   Sun Jan 26 17:00:05 2020 +0100
+++ b/scripts/gui/uigetfile.m   Sun Jan 26 21:08:25 2020 +0100
@@ -34,6 +34,8 @@
 ## Open a GUI dialog for selecting a file and return the filename @var{fname},
 ## the path to this file @var{fpath}, and the filter index @var{fltidx}.
 ##
+## If the user hits the Cancel button in the dialog, uigetdir returns a 0 of class double.
+##
 ## @var{flt} contains a (list of) file filter string(s) in one of the following
 ## formats:
 ##


A.R. Burgers <arb>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by siko1056 (Updated the item)
  • -email is unavailable- added by arb (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-01-28 rik5 StatusPatch Submitted Fixed
        Open/ClosedOpen Closed
    2020-01-27 siko1056 Severity3 - Normal 2 - Minor
        Priority5 - Normal 3 - Low
        StatusNone Patch Submitted

    Back to the top

    Powered by Savane 3.13-bb6a.
    Corresponding source code