imgui.extension.imguifiledialog

Class ImGuiFileDialog

java.lang.Object

imgui.extension.imguifiledialog.ImGuiFileDialog

public final class ImGuiFileDialog
extends java.lang.Object

ImGuiFileDialog extension for ImGui Repo: https://github.com/aiekick/ImGuiFileDialog

Method Summary

Modifier and Type	Method and Description
static void	close() close dialog
static boolean	display(java.lang.String vKey, int vFlags, float vMinSizeX, float vMinSizeY, float vMaxSizeX, float vMaxSizeY) Display / Close dialog form Display the dialog.
static java.lang.String	getCurrentFileName() Save File behavior : will always return the content of the field with current filter extension
static java.lang.String	getCurrentFilter() will return selected filter
static java.lang.String	getCurrentPath() will return current path
static java.lang.String	getFilePathName() Save File behavior : will always return the content of the field with current filter extention and current path
static java.lang.String	getOpenedKey() return the dialog key who is opened, return nothing if not opened
static java.util.HashMap<java.lang.String,java.lang.String>	getSelection() Open File behavior : will return selection via a map<FileName, FilePathName>
static long	getUserDatas() will return user datas sent with Open Dialog/Modal
static boolean	isOk() true: Dialog Closed with Ok result / false: Dialog closed with cancel result
static boolean	isOpened() say if the dialog is opened somewhere
static boolean	isOpened(java.lang.String vKey) say if the key is opened
static void	openDialog(java.lang.String vKey, java.lang.String vTitle, java.lang.String vFilters, java.lang.String vPath, java.lang.String vFileName, int vCountSelectionMax, long vUserDatas, int vFlags) open simple dialog (path and fileName can be specified)
static void	openModal(java.lang.String vKey, java.lang.String vTitle, java.lang.String vFilters, java.lang.String vFilePathName, ImGuiFileDialogPaneFun vSidePane, float vSidePaneWidth, int vCountSelectionMax, long vUserDatas, int vFlags) open modal with custom right pane (path and filename are obtained from filePathName)
static void	openModal(java.lang.String vKey, java.lang.String vTitle, java.lang.String vFilters, java.lang.String vFilePathName, int vCountSelectionMax, long vUserDatas, int vFlags) open simple modal (path and filename are obtained from filePathName)
static void	openModal(java.lang.String vKey, java.lang.String vTitle, java.lang.String vFilters, java.lang.String vPath, java.lang.String vFileName, ImGuiFileDialogPaneFun vSidePane, float vSidePaneWidth, int vCountSelectionMax, long vUserDatas, int vFlags) open modal with custom right pane (path and fileName can be specified)
static void	openModal(java.lang.String vKey, java.lang.String vTitle, java.lang.String vFilters, java.lang.String vPath, java.lang.String vFileName, int vCountSelectionMax, long vUserDatas, int vFlags) open simple modal (path and fileName can be specified)
static boolean	wasOpenedThisFrame() say if the dialog was already opened this frame
static boolean	wasOpenedThisFrame(java.lang.String vKey) say if the dialog key was already opened this frame

Methods inherited from class java.lang.Object

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

Method Detail

openDialog

public static void openDialog(java.lang.String vKey,
                              java.lang.String vTitle,
                              java.lang.String vFilters,
                              java.lang.String vPath,
                              java.lang.String vFileName,
                              int vCountSelectionMax,
                              long vUserDatas,
                              int vFlags)

open simple dialog (path and fileName can be specified)

Parameters:

vKey - key dialog

vTitle - title

vFilters - filters (in comma separated form i.e. ".png,.jpg" or ".*") or null for directories

vPath - path

vFileName - default file name

vCountSelectionMax - count selection max

vUserDatas - user datas (can be retrieved in pane)

vFlags - ImGuiFileDialogFlags

openModal

public static void openModal(java.lang.String vKey,
                             java.lang.String vTitle,
                             java.lang.String vFilters,
                             java.lang.String vPath,
                             java.lang.String vFileName,
                             int vCountSelectionMax,
                             long vUserDatas,
                             int vFlags)

open simple modal (path and fileName can be specified)

Parameters:

vKey - key dialog

vTitle - title

vFilters - filters (in comma separated form i.e. ".png,.jpg" or ".*") or null for directories

vPath - path

vFileName - default file name

vCountSelectionMax - count selection max

vUserDatas - user datas (can be retrieved in pane)

vFlags - ImGuiFileDialogFlags

openModal

public static void openModal(java.lang.String vKey,
                             java.lang.String vTitle,
                             java.lang.String vFilters,
                             java.lang.String vFilePathName,
                             int vCountSelectionMax,
                             long vUserDatas,
                             int vFlags)

open simple modal (path and filename are obtained from filePathName)

Parameters:

vKey - key dialog

vTitle - title

vFilters - filters (in comma separated form i.e. ".png,.jpg" or ".*") or null for directories

vFilePathName - file path name (will be decomposed in path and fileName)

vCountSelectionMax - count selection max

vUserDatas - user datas (can be retrieved in pane)

vFlags - ImGuiFileDialogFlags

openModal

public static void openModal(java.lang.String vKey,
                             java.lang.String vTitle,
                             java.lang.String vFilters,
                             java.lang.String vPath,
                             java.lang.String vFileName,
                             ImGuiFileDialogPaneFun vSidePane,
                             float vSidePaneWidth,
                             int vCountSelectionMax,
                             long vUserDatas,
                             int vFlags)

open modal with custom right pane (path and fileName can be specified)

Parameters:

vKey - key dialog

vTitle - title

vFilters - filters (in comma separated form i.e. ".png,.jpg" or ".*") or null for directories

vPath - path

vFileName - default file name

vSidePane - side pane

vSidePaneWidth - side pane width

vCountSelectionMax - count selection max

vUserDatas - user datas (can be retrieved in pane)

vFlags - ImGuiFileDialogFlags

openModal

public static void openModal(java.lang.String vKey,
                             java.lang.String vTitle,
                             java.lang.String vFilters,
                             java.lang.String vFilePathName,
                             ImGuiFileDialogPaneFun vSidePane,
                             float vSidePaneWidth,
                             int vCountSelectionMax,
                             long vUserDatas,
                             int vFlags)

open modal with custom right pane (path and filename are obtained from filePathName)

Parameters:

vKey - key dialog

vTitle - title

vFilters - filters (in comma separated form i.e. ".png,.jpg" or ".*") or null for directories

vFilePathName - file path name (will be decomposed in path and fileName)

vSidePane - side pane

vSidePaneWidth - side pane width

vCountSelectionMax - count selection max

vUserDatas - user datas (can be retrieved in pane)

vFlags - ImGuiFileDialogFlags

display

public static boolean display(java.lang.String vKey,
                              int vFlags,
                              float vMinSizeX,
                              float vMinSizeY,
                              float vMaxSizeX,
                              float vMaxSizeY)

Display / Close dialog form Display the dialog. return true if a result was obtained (Ok or not)

Parameters:

vKey - key dialog to display (if not the same key as defined by OpenDialog/Modal => no opening)

vFlags - ImGuiWindowFlags

vMinSizeX - minimal size constraint for the ImGuiWindow

vMinSizeY - minimal size constraint for the ImGuiWindow

vMaxSizeX - maximal size constraint for the ImGuiWindow

vMaxSizeY - maximal size constraint for the ImGuiWindow

Returns:

true if a result was obtained (Ok or not)

close

public static void close()

close dialog

wasOpenedThisFrame

public static boolean wasOpenedThisFrame(java.lang.String vKey)

say if the dialog key was already opened this frame

Parameters:

vKey - key dialog

Returns:

if the dialog key was already opened this frame

wasOpenedThisFrame

public static boolean wasOpenedThisFrame()

say if the dialog was already opened this frame

Returns:

if the dialog was already opened this frame

isOpened

public static boolean isOpened(java.lang.String vKey)

say if the key is opened

Parameters:

vKey - key dialog

Returns:

if the key is opened

isOpened

public static boolean isOpened()

say if the dialog is opened somewhere

Returns:

if the dialog is opened somewhere

getOpenedKey

public static java.lang.String getOpenedKey()

return the dialog key who is opened, return nothing if not opened

Returns:

the dialog key who is opened or nothing is not opened

isOk

public static boolean isOk()

true: Dialog Closed with Ok result / false: Dialog closed with cancel result

Returns:

True if the dialog closed with Ok result, or false with cancel result

getSelection

public static java.util.HashMap<java.lang.String,java.lang.String> getSelection()

Open File behavior : will return selection via a map<FileName, FilePathName>

For example, if a file is selected, say test.txt. Then the key value pair will be: 'test.txt', '/some/path/to/test.txt'

Returns:

Map of FileName to FilePathName in key,value pair

getFilePathName

public static java.lang.String getFilePathName()

Save File behavior : will always return the content of the field with current filter extention and current path

getCurrentFileName

public static java.lang.String getCurrentFileName()

Save File behavior : will always return the content of the field with current filter extension

Returns:

the content of the field with current filter extension

getCurrentPath

public static java.lang.String getCurrentPath()

will return current path

Returns:

the current path

getCurrentFilter

public static java.lang.String getCurrentFilter()

will return selected filter

Returns:

the selected filter

getUserDatas

public static long getUserDatas()

will return user datas sent with Open Dialog/Modal

Can be used to pass a long value to the dialog and get the value back. This long value can be a pointer to a native data structure.

Returns:

user datas sent with Open Dialog/Modal