basis/cocoa/dialogs/dialogs-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: cocoa.dialogs
   3
   4 HELP: <NSOpenPanel>
   5 { $values { "panel" "an " { $snippet "NSOpenPanel" } } }
   6 { $description "Creates a new " { $snippet "NSOpenPanel" } "." } ;
   7
   8 HELP: <NSSavePanel>
   9 { $values { "panel" "an " { $snippet "NSSavePanel" } } }
  10 { $description "Creates a new " { $snippet "NSSavePanel" } "." } ;
  11
  12 HELP: open-panel
  13 { $values { "paths" "a sequence of pathname strings" } }
  14 { $description "Displays a file open panel, and outputs a sequence of selected pathnames." } ;
  15
  16 HELP: save-panel
  17 { $values { "path" "a pathname string, or " { $link f } } { "paths" "a sequence of pathname strings" } }
  18 { $description "Displays a file save panel, and outputs the selected path, or " { $link f } " if the user cancelled the operation." } ;
  19
  20 ARTICLE: "cocoa-dialogs" "Cocoa file dialogs"
  21 "Open dialogs:"
  22 { $subsections
  23     <NSOpenPanel>
  24     open-panel
  25 }
  26 "Save dialogs:"
  27 { $subsections
  28     <NSSavePanel>
  29     save-panel
  30 } ;
  31
  32 IN: cocoa.dialogs
  33 ABOUT: "cocoa-dialogs"