Libraries.Interface.Controls.FileChooser Documentation

This class allows us to create an open or save dialog and to give it a file filter as an option. For example, we could allow the system to only accept png image files, xml files, or something else. We can also set default folders for where the chooser opens up.

Example Code

use Libraries.Game.Game
        use Libraries.Interface.Controls.FileChooser
        use Libraries.Interface.Controls.FileFilter
        use Libraries.System.File

        class Main is Game

            action Main
                StartGame()
            end

            action CreateGame
                FileChooser chooser
                File file = chooser:OpenFileDialog()
                if file not= undefined
                    output file:GetAbsolutePath()
                end
            end
        end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
ChooseFolderDialog(Libraries.System.File location)This action lets the user select a folder in a dialog, starting at the location specified in the file called location.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
OpenFileDialog(Libraries.System.File location)This action boots up a file choosing dialog at the location specified in the file called location.
OpenFileDialog(Libraries.Interface.Controls.FileFilter filter)This action boots up a file choosing dialog at the default location for a particular system.
OpenFileDialog()This action boots up a file choosing dialog at the default location for a particular system.
OpenFileDialog(Libraries.System.File location, Libraries.Interface.Controls.FileFilter filter)This action boots up a file choosing dialog at location specified in the location parameter.
SaveFileDialog(Libraries.System.File location, Libraries.Interface.Controls.FileFilter filter)This action boots up a file choosing dialog at location specified in the location parameter.
SaveFileDialog()This action boots up a file choosing dialog at the default location for a particular system.
SaveFileDialog(Libraries.Interface.Controls.FileFilter filter)This action boots up a file choosing dialog at the default location for a particular system.
SaveFileDialog(Libraries.System.File location)This action boots up a file choosing dialog at the location specified in the file called location.

Actions Documentation

ChooseFolderDialog(Libraries.System.File location)

This action lets the user select a folder in a dialog, starting at the location specified in the file called location.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    File location
                    File file = chooser:ChooseFolderDialog(location)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

OpenFileDialog(Libraries.System.File location)

This action boots up a file choosing dialog at the location specified in the file called location. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    File location
                    File file = chooser:OpenFileDialog(location)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

OpenFileDialog(Libraries.Interface.Controls.FileFilter filter)

This action boots up a file choosing dialog at the default location for a particular system. What this default is depends on the operating system, but would typically be something like a home directory or desktop. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    FileFilter filter
                    filter:Add("png")
                    File file = chooser:OpenFileDialog(filter)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

OpenFileDialog()

This action boots up a file choosing dialog at the default location for a particular system. What this default is depends on the operating system, but would typically be something like a home directory or desktop.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    File file = chooser:OpenFileDialog()
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Return

Libraries.System.File:

OpenFileDialog(Libraries.System.File location, Libraries.Interface.Controls.FileFilter filter)

This action boots up a file choosing dialog at location specified in the location parameter. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    FileFilter filter
                    filter:Add("png")
                    File file = chooser:OpenFileDialog(filter)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

SaveFileDialog(Libraries.System.File location, Libraries.Interface.Controls.FileFilter filter)

This action boots up a file choosing dialog at location specified in the location parameter. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    FileFilter filter
                    filter:Add("png")
                    File file = chooser:OpenFileDialog(filter)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

SaveFileDialog()

This action boots up a file choosing dialog at the default location for a particular system. What this default is depends on the operating system, but would typically be something like a home directory or desktop.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    File file = chooser:OpenFileDialog()
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Return

Libraries.System.File:

SaveFileDialog(Libraries.Interface.Controls.FileFilter filter)

This action boots up a file choosing dialog at the default location for a particular system. What this default is depends on the operating system, but would typically be something like a home directory or desktop. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    FileFilter filter
                    filter:Add("png")
                    File file = chooser:OpenFileDialog(filter)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File:

SaveFileDialog(Libraries.System.File location)

This action boots up a file choosing dialog at the location specified in the file called location. Additionally, this version includes a FileFilter.

Example Code

use Libraries.Game.Game
            use Libraries.Interface.Controls.FileChooser
            use Libraries.Interface.Controls.FileFilter
            use Libraries.System.File

            class Main is Game

                action Main
                    StartGame()
                end

                action CreateGame
                    FileChooser chooser
                    FileFilter filter
                    filter:Add("png")
                    File file = chooser:OpenFileDialog(filter)
                    if file not= undefined
                        output file:GetAbsolutePath()
                    end
                end
            end

Parameters

Return

Libraries.System.File: