"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 2002 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libtool' }"

"{ NameSpace: Smalltalk }"

SimpleDialog subclass:#FileDialog

	instanceVariableNames:'aspects treeBrowser directory pattern filterHolder initialText

		multipleSelect doubleClickAction cancelLabelHolder okLabelHolder

		startFilename result filterField filenameField viewFiles

		filenameLabelHolder isLoadDialog newDirectoryVisibilityHolder

		appendButtonVisibleHolder appendWasPressed

		buttonPanelVisibleHolder appendLabelHolder

		browseMenuItemVisibleHolder selectedDeviceDrive

		listOfDeviceDrives rootDirectoryHolder initialRoot

		verticalPanelView okLabelEnabled searchInfoBoxVisibleHolder

		searchedDirectoryInfoHolder additionalFolderItemsInMenu'

	classVariableNames:'AdditionalFolderItemsInMenu LastExtent LastFindPattern'

	poolDictionaries:''

	category:'Interface-Tools-File'

!

!FileDialog class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2002 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    A slightly better file dialog

    API of interest:

        [class side] additionalFolderItemsInMenu 

            optional list of additional folders to be presented

            in the directory menu.

            If not empty, entries will be added to EVERY file dialog.

        [instance side] additionalFolderItemsInMenu 

            optional list of additional folders to be presented in the directory menu.

            If not empty, entries will be added to this file dialog.

    [author:]

        Martin Walser (martin@vercingetorix)

    [instance variables:]

    [class variables:]

    [see also:]

"

!

examples

"

  usually direct access to FileDialog is not recommended;

  please use the Dialog interface, which is able to dispatch to

  alternative file choosers if the settings say so 

  (native dialogs, for example):

                                                                [exBegin]

    |fileOrNil|

    fileOrNil := Dialog requestFileName:'Choose a File'.

    Transcript showCR:fileOrNil

                                                                [exEnd]

  simple examples:

                                                                [exBegin]

    FileDialog 

        requestFileName:'enter a fileName:'

        default:''

        version:nil

        ifFail:['none']

        pattern:'*.conf'

        fromDirectory:'/etc'

        whenBoxCreatedEvaluate:nil.

                                                                [exEnd]

                                                                [exBegin]

    |fd|

    fd := FileDialog new.

    fd multipleSelect:true.

    fd open

                                                                [exEnd]

                                                                [exBegin]

    |fd|

    fd := FileDialog new.

    fd multipleSelect:true.

    fd browseMenuItemVisible:false.

    fd open

                                                                [exEnd]

    Adding custom components:

                                                                [exBegin]

    Dialog modifyingBoxWith:[:dialog |

        | fmtBox |

        fmtBox := ComboListView new.

        fmtBox list: #('Comma Separated Values (.csv)'

                        'Microsoft Excel (.xls)'

                        'Microsoft Excel XML (.xlsx)') .

        fmtBox model:'Select...' asValue.

        dialog application addComponent: fmtBox.

    ] do:[

        Dialog requestFileName: 'Save file as...'

    ]

                                                                [exEnd]

"

!

todo

"

    - make the filedialog windows like

      filename entry field shows only the filename not the whole directory

      the tree always starts in current directory

      the parent tree is shown in a combobox where the perents are selectable

    - do not expand the ~ or relative pathnames to absolute pathnames

"

! !

!FileDialog class methodsFor:'instance creation'!

requestDirectoryName:title default:aFileName ifFail:failBlock

    "same as requestFileName, but only show directories"

    ^ self  

        requestDirectoryName:title 

        default:aFileName 

        ok:nil 

        abort:nil 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:failBlock 

        whenBoxCreatedEvaluate:nil

        asLoadDialog:nil.

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName

        ifFail:'none'

    "

!

requestDirectoryName:title default:aFileName ok:okText abort:abortText ifFail:failBlock

    "same as requestFileName, but only show directories"

    ^ self  

        requestDirectoryName:title 

        default:aFileName 

        ok:okText 

        abort:abortText 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:failBlock 

        whenBoxCreatedEvaluate:nil

        asLoadDialog:nil.

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName

        ok:'Yes'

        abort:'No'

        ifFail:'none'

    "

!

requestDirectoryName:title default:aFileName ok:okText abort:abortText ifFail:failBlock acceptReturnAsOK:aBoolean

    "same as requestFileName, but only show directories"

    ^ self  

        requestDirectoryName:title 

        default:aFileName 

        ok:okText 

        abort:abortText 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:failBlock 

        whenBoxCreatedEvaluate:[:box|box doubleClickAction:[:index|box doAccept]]

        asLoadDialog:nil.

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName

        ok:'Yes'

        abort:'No'

        ifFail:'none'

    "

!

requestDirectoryName:titleString default:aFileName 

    ok:okText abort:abortText 

    version:versionSymbol 

    pattern:patternArg 

    fromDirectory:aDirectoryPath 

    ifFail:failBlock 

    whenBoxCreatedEvaluate:boxCreatedCallback 

    asLoadDialog:aBoolean

    "same as requestFileName, but only show directories"

    ^ self new

        requestDirectoryName:titleString default:aFileName 

        ok:okText abort:abortText 

        version:versionSymbol 

        pattern:patternArg 

        fromDirectory:aDirectoryPath 

        ifFail:failBlock 

        whenBoxCreatedEvaluate:boxCreatedCallback 

        asLoadDialog:aBoolean

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName

        ifFail:nil

    "

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName 

        ok:nil

        abort:nil 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:nil 

        whenBoxCreatedEvaluate:nil

        asLoadDialog:true

    "

!

requestDirectoryName:title default:aFileName ok:okText ifFail:failBlock

    "same as requestFileName, but only show directories"

    ^ self  

        requestDirectoryName:title 

        default:aFileName 

        ok:okText 

        abort:nil 

        version:nil 

        pattern:nil 

        fromDirectory:nil 

        ifFail:failBlock 

        whenBoxCreatedEvaluate:nil

        asLoadDialog:nil.

    "

     FileDialog

        requestDirectoryName:'which directory ?' 

        default:Filename currentDirectory pathName

        ok:'Yes'

        ifFail:'none'

    "

!

requestFileName:titleString default:defaultName ok:okText abort:abortText pattern:pattern fromDirectory:aDirectoryPathOrNil

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed."

    ^ self

        requestFileName:titleString 

        default:defaultName 

        ok:okText 

        abort:abortText 

        pattern:pattern 

        fromDirectory:aDirectoryPathOrNil 

        whenBoxCreatedEvaluate:nil

    "Created: / 14-02-2011 / 17:59:21 / cg"

!

requestFileName:titleString default:defaultName ok:okText abort:abortText pattern:pattern fromDirectory:aDirectoryPathOrNil whenBoxCreatedEvaluate:boxCreatedCallback

    ^ self  

        requestFileName:titleString 

        default:defaultName 

        ok:okText 

        abort:abortText 

        version:nil 

        ifFail:nil 

        pattern:pattern 

        fromDirectory:aDirectoryPathOrNil 

        whenBoxCreatedEvaluate:boxCreatedCallback

!

requestFileName:titleString default:defaultName ok:okText abort:abortText version:versionSymbol ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPath whenBoxCreatedEvaluate:boxCreatedCallback

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed

     The version argument allows validation of the files existance;

     it may be any of:

        #mustBeNew      - fail (return empty string) if the file exists

        #new            - confirm if the file exists

        #mustBeOld      - fail if the file does not exist

        #old            - confirm if the file does not exist

        #any (other)    - no validation

    "

    ^ self  

        requestFileName:titleString 

        default:defaultName 

        ok:okText 

        abort:abortText 

        version:versionSymbol 

        ifFail:failBlock 

        pattern:pattern 

        fromDirectory:aDirectoryPath 

        whenBoxCreatedEvaluate:boxCreatedCallback 

        asLoadDialog:nil

!

requestFileName:titleString default:defaultName ok:okText abort:abortText 

    version:versionSymbol 

    ifFail:failBlock 

    pattern:patternArg 

    fromDirectory:aDirectoryPath 

    whenBoxCreatedEvaluate:boxCreatedCallback 

    asLoadDialog:aBoolean

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those in aDirectoryPathOrNil, or the

     last fileBox directory (default: current directory) (if a nil path is given).

     The box will show okText in its okButton, abortText in the abortButton.

     The matchPattern is set to pattern initially.

     Return the string, or nil if cancel was pressed

     The version argument allows validation of the files existance;

     it may be any of:

        #mustBeNew      - fail (return empty string) if the file exists

        #new            - confirm if the file exists

        #mustBeOld      - fail if the file does not exist

        #old            - confirm if the file does not exist

        #any (other)    - no validation

    "

    ^ self new

        requestFileName:titleString default:defaultName ok:okText abort:abortText 

        version:versionSymbol 

        ifFail:failBlock 

        pattern:patternArg 

        fromDirectory:aDirectoryPath 

        whenBoxCreatedEvaluate:boxCreatedCallback 

        asLoadDialog:aBoolean

"/    |patternUsed instance enteredFileName enteredFileNameString|

"/

"/    patternUsed := FileSelectionBox lastSuffixPatternUsedForDefault:patternArg.

"/

"/    instance := self    

"/        startApplicationFor:titleString 

"/        default:defaultName 

"/        ok:okText 

"/        abort:abortText 

"/        ifFail:failBlock 

"/        pattern:patternUsed 

"/        fromDirectory:aDirectoryPath 

"/        whenBoxCreatedEvaluate:boxCreatedCallback

"/        asLoadDialog:aBoolean

"/        viewFiles:true

"/        multipleSelect:false.

"/

"/    enteredFileNameString := instance result.

"/    enteredFileNameString isEmptyOrNil ifTrue:[

"/        ^ failBlock value

"/    ].

"/

"/    enteredFileName := enteredFileNameString asFilename.

"/    enteredFileName isRelative ifTrue:[

"/        (versionSymbol isNil and:[#(http https ftp) includes:(enteredFileNameString upToAll:'://')]) ifTrue:[

"/            ^ enteredFileNameString.

"/        ] ifFalse:[

"/            enteredFileName := instance directory construct:enteredFileNameString.

"/            enteredFileNameString := enteredFileName asString.

"/        ].

"/    ].

"/

"/    FileSelectionBox lastFileSelectionDirectory:(enteredFileName directoryName).

"/    (patternArg notEmptyOrNil and:[instance pattern ~= patternArg]) ifTrue:[

"/        FileSelectionBox lastSuffixPatternUsedForDefault:patternArg is:instance pattern

"/    ].

"/

"/    versionSymbol isNil ifTrue:[ ^ enteredFileNameString].

"/    versionSymbol == #mustBeNew ifTrue:[

"/        "/ file must not exist

"/        enteredFileName exists ifTrue:[^ failBlock value].

"/    ].

"/    versionSymbol == #new ifTrue:[

"/        "/ file should not exist

"/        enteredFileName exists ifTrue:[

"/            (Dialog confirm:(self classResources stringWithCRs:'''%1'' exists.\\Continue anyway ?' with:enteredFileNameString))

"/                ifFalse:[^ failBlock value].

"/        ].

"/    ].

"/    versionSymbol == #mustBeOld ifTrue:[

"/        "/ file must exist

"/        enteredFileName exists ifFalse:[^ failBlock value].

"/    ].

"/    versionSymbol == #old ifTrue:[

"/        "/ file should exist

"/        enteredFileName exists ifFalse:[

"/            (self confirm:(self classResources stringWithCRs:'''%1'' does not exist yet.\\Continue anyway ?' with:enteredFileNameString))

"/            ifFalse:[^ failBlock value].

"/        ].

"/    ].

"/

"/    ^ enteredFileNameString

    "

     FileDialog 

        requestFileName:'enter a fileName:'

        default:''

        ok:nil 

        abort:nil

        version:nil

        ifFail:['none']

        pattern:'*'

        fromDirectory:Filename currentDirectory pathName

        whenBoxCreatedEvaluate:nil

        asLoadDialog:true

    "

!

requestFileName:titleString default:defaultName pattern:pattern fromDirectory:aDirectory

    "launch a Dialog, which allows user to enter a filename.

     The files presented initially are those from the current directory.

     The box will show ok/cancel in its buttons.

     The matchPattern is set to pattern initially.

     Return the string or nil if cancel was pressed."

    |resources|

    resources := self classResources.

    ^ self 

        requestFileName:titleString 

        default:defaultName

        ok:(resources string:'OK') 

        abort:(resources string:'Cancel') 

        pattern:pattern

        fromDirectory:aDirectory

    "Created: / 14-02-2011 / 17:59:14 / cg"

!

requestFileName:titleString default:defaultName version:versionSymbol ifFail:failBlock pattern:pattern fromDirectory:aDirectoryPathOrNil whenBoxCreatedEvaluate:boxCreatedCallback

    ^ self  

        requestFileName:titleString 

        default:defaultName 

        ok:nil 

        abort:nil 

        version:versionSymbol 

        ifFail:failBlock 

        pattern:pattern 

        fromDirectory:aDirectoryPathOrNil