HelpSource/Classes/Dialog.schelp

   1 CLASS:: Dialog
   2 redirect:: implClass
   3 summary:: Shows various system dialogs
   4 categories:: GUI>Accessories
   5
   6 DESCRIPTION::
   7 This class allows to show various system dialogs. link::#*openPanel:: will show a dialog for selecting a file to open, and link::#*savePanel:: will show a dialog for selecting or creating a file to save to.
   8
   9
  10 CLASSMETHODS::
  11 PRIVATE:: key
  12
  13 METHOD:: openPanel
  14         Shows a dialog for selection of an existing file (or multiple files) to open. It does not do anything with the file, instead it just passes the chosen filenames to the given result handler.
  15
  16         ARGUMENT:: okFunc
  17                 An object to be evaluated when OK is pressed. As argument, either a single filename is passed as a String, or an Array of Strings for multiple selected items is passed, depending on the strong::multipleSelection:: argument.
  18         ARGUMENT:: cancelFunc
  19                 An object to be evaluated when Cancel is pressed.
  20         ARGUMENT:: multipleSelection
  21                 A Boolean indicating whether multiple files can be selected.
  22         DISCUSSION::
  23         Example:
  24 code::
  25 (
  26 Dialog.openPanel({ arg path;
  27         path.postln;
  28 },{
  29         "cancelled".postln;
  30 });
  31 )
  32 ::
  33
  34 METHOD:: savePanel
  35         Shows a dialog for selecting or creating a file to save to. It does not do anything with the selected file, and does not create any file; instead it just passes the chosen filename to the given result handler.
  36
  37         ARGUMENT:: okFunc
  38                 An object to be evaluated when OK is pressed. The chosen filename is passed as a String as argument.
  39         ARGUMENT:: cancelFunc
  40                 An object to be evaluated when Cancel is pressed.
  41         DISCUSSION::
  42         Example:
  43 code::
  44 (
  45 Dialog.savePanel({ arg path;
  46         path.postln;
  47 },{
  48         "cancelled".postln;
  49 });
  50 )
  51 ::
  52
  53 METHOD:: getPaths
  54         note::Deprecated. Use link::#*openPanel:: instead. ::
  55
  56         Implements the same functionality as *openPanel, only the last argument is named differently and defaults to true.