Package org.lwjgl.util.tinyfd

Class TinyFileDialogs

java.lang.Object
org.lwjgl.util.tinyfd.TinyFileDialogs
public class TinyFileDialogs extends Object
Bindings to tiny file dialogs, a native dialog library with support for:
  • message / question
  • input / password
  • save file
  • open file & multiple files
  • select folder
  • color picker

The dialogs can be forced into console mode.

  • Field Details

    • tinyfd_version

      public static final String tinyfd_version
      Contains tinyfd current version number.
      See Also:

    • tinyfd_needs

      public static final String tinyfd_needs
      Contains info about requirements.
      See Also:

    • tinyfd_response

      public static final String tinyfd_response
      If you pass "tinyfd_query" as aTitle, the functions will not display the dialogs but will fill tinyfd_response with the retain solution and return 0 for console mode, 1 for graphic mode.

      Possible values for tinyfd_response are (all lowercase) for the graphic mode:

      
 windows_wchar windows applescript kdialog zenity zenity3 matedialog
 shellementary qarma yad python2-tkinter python3-tkinter python-dbus
 perl-dbus gxmessage gmessage xmessage xdialog gdialog

      For the console mode:

      
 dialog whiptail basicinput no_solution
      See Also:

    • tinyfd_verbose

      public static final String tinyfd_verbose
      0 (default) or 1 : on unix, prints the command line calls
      See Also:

    • tinyfd_silent

      public static final String tinyfd_silent
      1 (default) or 0 : on unix, hide errors and warnings from called dialogs
      See Also:

    • tinyfd_allowCursesDialogs

      public static final String tinyfd_allowCursesDialogs
      Curses dialogs are difficult to use, on windows they are only ascii and uses the unix backslash
      See Also:

    • tinyfd_forceConsole

      public static final String tinyfd_forceConsole
      0 (default) or 1. For unix & windows: 0 (graphic mode) or 1 (console mode).

      0: try to use a graphic solution, if it fails then it uses console mode.

      1: forces all dialogs into console mode even when an X server is present, it can use the package dialog or dialog.exe. On windows it only make sense for console applications

      See Also:

    • tinyfd_assumeGraphicDisplay

      public static final String tinyfd_assumeGraphicDisplay
      0 (default) or 1.

      Some systems don't set the environment variable DISPLAY even when a graphic display is present. Set this to 1 to tell tinyfiledialogs to assume the existence of a graphic display.

      See Also:

    • tinyfd_winUtf8

      public static final String tinyfd_winUtf8
      On windows, set to 1 if you want to use UTF-8.

      LWJGL note: this is automatically set to 1.

      See Also:

  • Method Details

    • ntinyfd_getGlobalChar

      public static long ntinyfd_getGlobalChar(long aCharVariableName)
      Unsafe version of: getGlobalChar

    • tinyfd_getGlobalChar

      public static @Nullable String tinyfd_getGlobalChar(ByteBuffer aCharVariableName)
      Parameters:
      aCharVariableName - one of:
      versionneedsresponse
      Returns:
      NULL on error

    • tinyfd_getGlobalChar

      public static @Nullable String tinyfd_getGlobalChar(CharSequence aCharVariableName)
      Parameters:
      aCharVariableName - one of:
      versionneedsresponse
      Returns:
      NULL on error

    • ntinyfd_getGlobalInt

      public static int ntinyfd_getGlobalInt(long aIntVariableName)
      Unsafe version of: getGlobalInt

    • tinyfd_getGlobalInt

      public static int tinyfd_getGlobalInt(ByteBuffer aIntVariableName)
      Parameters:
      aIntVariableName - one of:
      verbosesilentallowCursesDialogsforceConsoleassumeGraphicDisplaywinUtf8
      Returns:
      -1 on error

    • tinyfd_getGlobalInt

      public static int tinyfd_getGlobalInt(CharSequence aIntVariableName)
      Parameters:
      aIntVariableName - one of:
      verbosesilentallowCursesDialogsforceConsoleassumeGraphicDisplaywinUtf8
      Returns:
      -1 on error

    • ntinyfd_setGlobalInt

      public static int ntinyfd_setGlobalInt(long aIntVariableName, int aValue)
      Unsafe version of: setGlobalInt

    • tinyfd_setGlobalInt

      public static int tinyfd_setGlobalInt(ByteBuffer aIntVariableName, int aValue)
      Parameters:
      aIntVariableName - one of:
      verbosesilentallowCursesDialogsforceConsoleassumeGraphicDisplaywinUtf8
      Returns:
      -1 on error

    • tinyfd_setGlobalInt

      public static int tinyfd_setGlobalInt(CharSequence aIntVariableName, int aValue)
      Parameters:
      aIntVariableName - one of:
      verbosesilentallowCursesDialogsforceConsoleassumeGraphicDisplaywinUtf8
      Returns:
      -1 on error

    • tinyfd_beep

      public static void tinyfd_beep()

    • ntinyfd_notifyPopup

      public static int ntinyfd_notifyPopup(long aTitle, long aMessage, long aIconType)
      Unsafe version of: notifyPopup

    • tinyfd_notifyPopup

      public static int tinyfd_notifyPopup(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aMessage, ByteBuffer aIconType)
      Displays a notification popup.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. It may contain \n and \t characters.
      aIconType - the icon type. One of:
      "info""warning""error"

    • tinyfd_notifyPopup

      public static int tinyfd_notifyPopup(@Nullable CharSequence aTitle, @Nullable CharSequence aMessage, CharSequence aIconType)
      Displays a notification popup.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. It may contain \n and \t characters.
      aIconType - the icon type. One of:
      "info""warning""error"

    • ntinyfd_messageBox

      public static int ntinyfd_messageBox(long aTitle, long aMessage, long aDialogType, long aIconType, int aDefaultButton)
      Unsafe version of: messageBox

    • tinyfd_messageBox

      public static boolean tinyfd_messageBox(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aMessage, ByteBuffer aDialogType, ByteBuffer aIconType, boolean aDefaultButton)
      Displays a message dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. It may contain \n and \t characters.
      aDialogType - the dialog type. One of:
      "ok""okcancel""yesno""yesnocancel"
      aIconType - the icon type. One of:
      "info""warning""error""question"
      aDefaultButton - 0 for cancel/no, 1 for ok/yes
      Returns:
      0 for cancel/no, 1 for ok/yes, 2 for no in yesnocancel

    • tinyfd_messageBox

      public static boolean tinyfd_messageBox(@Nullable CharSequence aTitle, @Nullable CharSequence aMessage, CharSequence aDialogType, CharSequence aIconType, boolean aDefaultButton)
      Displays a message dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. It may contain \n and \t characters.
      aDialogType - the dialog type. One of:
      "ok""okcancel""yesno""yesnocancel"
      aIconType - the icon type. One of:
      "info""warning""error""question"
      aDefaultButton - 0 for cancel/no, 1 for ok/yes
      Returns:
      0 for cancel/no, 1 for ok/yes, 2 for no in yesnocancel

    • ntinyfd_inputBox

      public static long ntinyfd_inputBox(long aTitle, long aMessage, long aDefaultInput)
      Unsafe version of: inputBox

    • tinyfd_inputBox

      public static @Nullable String tinyfd_inputBox(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aMessage, @Nullable ByteBuffer aDefaultInput)
      Displays an input dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. May NOT contain \n and \t characters on Windows.
      aDefaultInput - if NULL it's a password box
      Returns:
      the input value or NULL on cancel

    • tinyfd_inputBox

      public static @Nullable String tinyfd_inputBox(@Nullable CharSequence aTitle, @Nullable CharSequence aMessage, @Nullable CharSequence aDefaultInput)
      Displays an input dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aMessage - the message or NULL. May NOT contain \n and \t characters on Windows.
      aDefaultInput - if NULL it's a password box
      Returns:
      the input value or NULL on cancel

    • ntinyfd_saveFileDialog

      public static long ntinyfd_saveFileDialog(long aTitle, long aDefaultPathAndOrFile, int aNumOfFilterPatterns, long aFilterPatterns, long aSingleFilterDescription)
      Unsafe version of: saveFileDialog
      Parameters:
      aNumOfFilterPatterns - the number of patterns in aFilterPatterns

    • tinyfd_saveFileDialog

      public static @Nullable String tinyfd_saveFileDialog(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aDefaultPathAndOrFile, @Nullable org.lwjgl.PointerBuffer aFilterPatterns, @Nullable ByteBuffer aSingleFilterDescription)
      Displays a file save dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPathAndOrFile - NULL or the default path and/or file, ends with / to set only a directory
      aFilterPatterns - an array of file type patterns (NULL or {"*.jpg","*.png"}
      aSingleFilterDescription - NULL or "image files"
      Returns:
      the selected file path or NULL on cancel

    • tinyfd_saveFileDialog

      public static @Nullable String tinyfd_saveFileDialog(@Nullable CharSequence aTitle, @Nullable CharSequence aDefaultPathAndOrFile, @Nullable org.lwjgl.PointerBuffer aFilterPatterns, @Nullable CharSequence aSingleFilterDescription)
      Displays a file save dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPathAndOrFile - NULL or the default path and/or file, ends with / to set only a directory
      aFilterPatterns - an array of file type patterns (NULL or {"*.jpg","*.png"}
      aSingleFilterDescription - NULL or "image files"
      Returns:
      the selected file path or NULL on cancel

    • ntinyfd_openFileDialog

      public static long ntinyfd_openFileDialog(long aTitle, long aDefaultPathAndOrFile, int aNumOfFilterPatterns, long aFilterPatterns, long aSingleFilterDescription, int aAllowMultipleSelects)
      Unsafe version of: openFileDialog
      Parameters:
      aNumOfFilterPatterns - the number of patterns in aFilterPatterns

    • tinyfd_openFileDialog

      public static @Nullable String tinyfd_openFileDialog(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aDefaultPathAndOrFile, @Nullable org.lwjgl.PointerBuffer aFilterPatterns, @Nullable ByteBuffer aSingleFilterDescription, boolean aAllowMultipleSelects)
      Displays a file open dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPathAndOrFile - NULL or the default path and/or file, ends with / to set only a directory
      aFilterPatterns - an array of file type patterns (NULL or {"*.jpg","*.png"}
      aSingleFilterDescription - NULL or "image files"
      aAllowMultipleSelects - if true, multiple selections are allowed
      Returns:
      the file(s) selected or NULL on cancel. In case of multiple files, the separator is '|'.

    • tinyfd_openFileDialog

      public static @Nullable String tinyfd_openFileDialog(@Nullable CharSequence aTitle, @Nullable CharSequence aDefaultPathAndOrFile, @Nullable org.lwjgl.PointerBuffer aFilterPatterns, @Nullable CharSequence aSingleFilterDescription, boolean aAllowMultipleSelects)
      Displays a file open dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPathAndOrFile - NULL or the default path and/or file, ends with / to set only a directory
      aFilterPatterns - an array of file type patterns (NULL or {"*.jpg","*.png"}
      aSingleFilterDescription - NULL or "image files"
      aAllowMultipleSelects - if true, multiple selections are allowed
      Returns:
      the file(s) selected or NULL on cancel. In case of multiple files, the separator is '|'.

    • ntinyfd_selectFolderDialog

      public static long ntinyfd_selectFolderDialog(long aTitle, long aDefaultPath)
      Unsafe version of: selectFolderDialog

    • tinyfd_selectFolderDialog

      public static @Nullable String tinyfd_selectFolderDialog(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aDefaultPath)
      Displays a folder selection dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPath - the default path or NULL

    • tinyfd_selectFolderDialog

      public static @Nullable String tinyfd_selectFolderDialog(@Nullable CharSequence aTitle, @Nullable CharSequence aDefaultPath)
      Displays a folder selection dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultPath - the default path or NULL

    • ntinyfd_colorChooser

      public static long ntinyfd_colorChooser(long aTitle, long aDefaultHexRGB, long aDefaultRGB, long aoResultRGB)
      Unsafe version of: colorChooser

    • tinyfd_colorChooser

      public static @Nullable String tinyfd_colorChooser(@Nullable ByteBuffer aTitle, @Nullable ByteBuffer aDefaultHexRGB, @Nullable ByteBuffer aDefaultRGB, ByteBuffer aoResultRGB)
      Displays a color chooser dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultHexRGB - NULL or "#FF0000"
      aDefaultRGB - { 0 , 255 , 255 }. Used only if aDefaultHexRGB is NULL.
      aoResultRGB - returns the selected color. aDefaultRGB and aoResultRGB can be the same array.
      Returns:
      the selected hexcolor as a string "#FF0000" or NULL on cancel

    • tinyfd_colorChooser

      public static @Nullable String tinyfd_colorChooser(@Nullable CharSequence aTitle, @Nullable CharSequence aDefaultHexRGB, @Nullable ByteBuffer aDefaultRGB, ByteBuffer aoResultRGB)
      Displays a color chooser dialog.
      Parameters:
      aTitle - the dialog title or NULL
      aDefaultHexRGB - NULL or "#FF0000"
      aDefaultRGB - { 0 , 255 , 255 }. Used only if aDefaultHexRGB is NULL.
      aoResultRGB - returns the selected color. aDefaultRGB and aoResultRGB can be the same array.
      Returns:
      the selected hexcolor as a string "#FF0000" or NULL on cancel