org.lwjgl.util.tinyfd

Class TinyFileDialogs

java.lang.Object

org.lwjgl.util.tinyfd.TinyFileDialogs

public class TinyFileDialogs
extends java.lang.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 Summary

Fields

Modifier and Type	Field and Description
static java.nio.IntBuffer	tinyfd_forceConsole Can be modified at run time.
static java.lang.String	tinyfd_needs Contains info about requirements.
static java.nio.IntBuffer	tinyfd_silent 1 (default) or 0 : on unix, hide errors and warnings from called dialog.
static java.nio.IntBuffer	tinyfd_verbose 0 (default) or 1 : on unix, prints the command line calls.
static java.lang.String	tinyfd_version Contains tinyfd current version number.

Method Summary

Modifier and Type	Method and Description
static long	ntinyfd_colorChooser(long aTitle, long aDefaultHexRGB, long aDefaultRGB, long aoResultRGB) Unsafe version of: colorChooser
static long	ntinyfd_inputBox(long aTitle, long aMessage, long aDefaultInput) Unsafe version of: inputBox
static int	ntinyfd_messageBox(long aTitle, long aMessage, long aDialogType, long aIconType, int aDefaultButton) Unsafe version of: messageBox
static int	ntinyfd_notifyPopup(long aTitle, long aMessage, long aIconType) Unsafe version of: notifyPopup
static long	ntinyfd_openFileDialog(long aTitle, long aDefaultPathAndFile, int aNumOfFilterPatterns, long aFilterPatterns, long aSingleFilterDescription, int aAllowMultipleSelects) Unsafe version of: openFileDialog
static long	ntinyfd_response() Unsafe version of: response
static long	ntinyfd_saveFileDialog(long aTitle, long aDefaultPathAndFile, int aNumOfFilterPatterns, long aFilterPatterns, long aSingleFilterDescription) Unsafe version of: saveFileDialog
static long	ntinyfd_selectFolderDialog(long aTitle, long aDefaultPath) Unsafe version of: selectFolderDialog
static void	tinyfd_beep()
static java.lang.String	tinyfd_colorChooser(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aDefaultHexRGB, java.nio.ByteBuffer aDefaultRGB, java.nio.ByteBuffer aoResultRGB) Displays a color chooser dialog.
static java.lang.String	tinyfd_colorChooser(java.lang.CharSequence aTitle, java.lang.CharSequence aDefaultHexRGB, java.nio.ByteBuffer aDefaultRGB, java.nio.ByteBuffer aoResultRGB) Displays a color chooser dialog.
static java.lang.String	tinyfd_inputBox(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aMessage, java.nio.ByteBuffer aDefaultInput) Displays an input dialog.
static java.lang.String	tinyfd_inputBox(java.lang.CharSequence aTitle, java.lang.CharSequence aMessage, java.lang.CharSequence aDefaultInput) Displays an input dialog.
static boolean	tinyfd_messageBox(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aMessage, java.nio.ByteBuffer aDialogType, java.nio.ByteBuffer aIconType, boolean aDefaultButton) Displays a message dialog.
static boolean	tinyfd_messageBox(java.lang.CharSequence aTitle, java.lang.CharSequence aMessage, java.lang.CharSequence aDialogType, java.lang.CharSequence aIconType, boolean aDefaultButton) Displays a message dialog.
static int	tinyfd_notifyPopup(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aMessage, java.nio.ByteBuffer aIconType) Displays a notification popup.
static int	tinyfd_notifyPopup(java.lang.CharSequence aTitle, java.lang.CharSequence aMessage, java.lang.CharSequence aIconType) Displays a notification popup.
static java.lang.String	tinyfd_openFileDialog(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aDefaultPathAndFile, org.lwjgl.PointerBuffer aFilterPatterns, java.nio.ByteBuffer aSingleFilterDescription, boolean aAllowMultipleSelects) Displays a file open dialog.
static java.lang.String	tinyfd_openFileDialog(java.lang.CharSequence aTitle, java.lang.CharSequence aDefaultPathAndFile, org.lwjgl.PointerBuffer aFilterPatterns, java.lang.CharSequence aSingleFilterDescription, boolean aAllowMultipleSelects) Displays a file open dialog.
static java.lang.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:
static java.lang.String	tinyfd_saveFileDialog(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aDefaultPathAndFile, org.lwjgl.PointerBuffer aFilterPatterns, java.nio.ByteBuffer aSingleFilterDescription) Displays a file save dialog.
static java.lang.String	tinyfd_saveFileDialog(java.lang.CharSequence aTitle, java.lang.CharSequence aDefaultPathAndFile, org.lwjgl.PointerBuffer aFilterPatterns, java.lang.CharSequence aSingleFilterDescription) Displays a file save dialog.
static java.lang.String	tinyfd_selectFolderDialog(java.nio.ByteBuffer aTitle, java.nio.ByteBuffer aDefaultPath) Displays a folder selection dialog.
static java.lang.String	tinyfd_selectFolderDialog(java.lang.CharSequence aTitle, java.lang.CharSequence aDefaultPath) Displays a folder selection dialog.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tinyfd_version

public static final java.lang.String tinyfd_version

Contains tinyfd current version number.

tinyfd_needs

public static final java.lang.String tinyfd_needs

Contains info about requirements.

tinyfd_verbose

public static final java.nio.IntBuffer tinyfd_verbose

0 (default) or 1 : on unix, prints the command line calls.

tinyfd_silent

public static final java.nio.IntBuffer tinyfd_silent

1 (default) or 0 : on unix, hide errors and warnings from called dialog.

tinyfd_forceConsole

public static final java.nio.IntBuffer tinyfd_forceConsole

Can be modified at run time.

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 the X server is present. It will use the package dialog or dialog.exe if installed. On windows it only makes sense for console applications.

Method Detail

ntinyfd_response

public static long ntinyfd_response()

Unsafe version of: response

tinyfd_response

public static java.lang.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:

Possible values for tinyfd_response are (all lowercase) for the graphic mode: windows applescript zenity zenity3 matedialog kdialog xdialog tkinter gdialog gxmessage xmessage

For the console mode: dialog whiptail basicinput

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
                                     java.nio.ByteBuffer aTitle,
                                     @Nullable
                                     java.nio.ByteBuffer aMessage,
                                     java.nio.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
                                     java.lang.CharSequence aTitle,
                                     @Nullable
                                     java.lang.CharSequence aMessage,
                                     java.lang.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
                                        java.nio.ByteBuffer aTitle,
                                        @Nullable
                                        java.nio.ByteBuffer aMessage,
                                        java.nio.ByteBuffer aDialogType,
                                        java.nio.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
                                        java.lang.CharSequence aTitle,
                                        @Nullable
                                        java.lang.CharSequence aMessage,
                                        java.lang.CharSequence aDialogType,
                                        java.lang.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

@Nullable
public static java.lang.String tinyfd_inputBox(@Nullable
                                                         java.nio.ByteBuffer aTitle,
                                                         @Nullable
                                                         java.nio.ByteBuffer aMessage,
                                                         @Nullable
                                                         java.nio.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

@Nullable
public static java.lang.String tinyfd_inputBox(@Nullable
                                                         java.lang.CharSequence aTitle,
                                                         @Nullable
                                                         java.lang.CharSequence aMessage,
                                                         @Nullable
                                                         java.lang.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 aDefaultPathAndFile,
                                          int aNumOfFilterPatterns,
                                          long aFilterPatterns,
                                          long aSingleFilterDescription)

Unsafe version of: saveFileDialog

Parameters:

aNumOfFilterPatterns - the number of patterns in aFilterPatterns

tinyfd_saveFileDialog

@Nullable
public static java.lang.String tinyfd_saveFileDialog(@Nullable
                                                               java.nio.ByteBuffer aTitle,
                                                               @Nullable
                                                               java.nio.ByteBuffer aDefaultPathAndFile,
                                                               @Nullable
                                                               org.lwjgl.PointerBuffer aFilterPatterns,
                                                               @Nullable
                                                               java.nio.ByteBuffer aSingleFilterDescription)

Displays a file save dialog.

Parameters:

aTitle - the dialog title or NULL

aDefaultPathAndFile - the default path and/or file or NULL

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

@Nullable
public static java.lang.String tinyfd_saveFileDialog(@Nullable
                                                               java.lang.CharSequence aTitle,
                                                               @Nullable
                                                               java.lang.CharSequence aDefaultPathAndFile,
                                                               @Nullable
                                                               org.lwjgl.PointerBuffer aFilterPatterns,
                                                               @Nullable
                                                               java.lang.CharSequence aSingleFilterDescription)

Displays a file save dialog.

Parameters:

aTitle - the dialog title or NULL

aDefaultPathAndFile - the default path and/or file or NULL

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 aDefaultPathAndFile,
                                          int aNumOfFilterPatterns,
                                          long aFilterPatterns,
                                          long aSingleFilterDescription,
                                          int aAllowMultipleSelects)

Unsafe version of: openFileDialog

Parameters:

aNumOfFilterPatterns - the number of patterns in aFilterPatterns

tinyfd_openFileDialog

@Nullable
public static java.lang.String tinyfd_openFileDialog(@Nullable
                                                               java.nio.ByteBuffer aTitle,
                                                               @Nullable
                                                               java.nio.ByteBuffer aDefaultPathAndFile,
                                                               @Nullable
                                                               org.lwjgl.PointerBuffer aFilterPatterns,
                                                               @Nullable
                                                               java.nio.ByteBuffer aSingleFilterDescription,
                                                               boolean aAllowMultipleSelects)

Displays a file open dialog.

Parameters:

aTitle - the dialog title or NULL

aDefaultPathAndFile - the default path and/or file or NULL

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

@Nullable
public static java.lang.String tinyfd_openFileDialog(@Nullable
                                                               java.lang.CharSequence aTitle,
                                                               @Nullable
                                                               java.lang.CharSequence aDefaultPathAndFile,
                                                               @Nullable
                                                               org.lwjgl.PointerBuffer aFilterPatterns,
                                                               @Nullable
                                                               java.lang.CharSequence aSingleFilterDescription,
                                                               boolean aAllowMultipleSelects)

Displays a file open dialog.

Parameters:

aTitle - the dialog title or NULL

aDefaultPathAndFile - the default path and/or file or NULL

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

@Nullable
public static java.lang.String tinyfd_selectFolderDialog(@Nullable
                                                                   java.nio.ByteBuffer aTitle,
                                                                   java.nio.ByteBuffer aDefaultPath)

Displays a folder selection dialog.

Parameters:

aTitle - the dialog title or NULL

aDefaultPath - the default path or NULL

tinyfd_selectFolderDialog

@Nullable
public static java.lang.String tinyfd_selectFolderDialog(@Nullable
                                                                   java.lang.CharSequence aTitle,
                                                                   java.lang.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

@Nullable
public static java.lang.String tinyfd_colorChooser(@Nullable
                                                             java.nio.ByteBuffer aTitle,
                                                             @Nullable
                                                             java.nio.ByteBuffer aDefaultHexRGB,
                                                             @Nullable
                                                             java.nio.ByteBuffer aDefaultRGB,
                                                             java.nio.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

@Nullable
public static java.lang.String tinyfd_colorChooser(@Nullable
                                                             java.lang.CharSequence aTitle,
                                                             @Nullable
                                                             java.lang.CharSequence aDefaultHexRGB,
                                                             @Nullable
                                                             java.nio.ByteBuffer aDefaultRGB,
                                                             java.nio.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