ImGuiFileDialog.h File Reference

#include "ImGuiFileDialogConfig.h"
#include <stdint.h>

Go to the source code of this file.

Classes
struct	IGFD_FileDialog_Config
struct	IGFD_Selection_Pair
struct	IGFD_Selection

Macros
#define	IGFD_VERSION   "v0.6.9 WIP"
#define	IGFD_IMGUI_SUPPORTED_VERSION   "1.92.3"
#define	IGFD_API
#define	IGFD_C_API

Typedefs
typedef int	IGFD_FileStyleFlags
typedef int	ImGuiFileDialogFlags
typedef int	IGFD_ResultMode
typedef struct ImGuiFileDialog	ImGuiFileDialog
typedef struct IGFD_Selection_Pair	IGFD_Selection_Pair
typedef struct IGFD_Selection	IGFD_Selection
typedef void(*	IGFD_PaneFun) (const char *, void *, bool *)

Enumerations
enum	IGFD_FileStyleFlags_ {   IGFD_FileStyle_None = 0 , IGFD_FileStyleByTypeFile = (1 << 0) , IGFD_FileStyleByTypeDir = (1 << 1) , IGFD_FileStyleByTypeLink = (1 << 2) ,   IGFD_FileStyleByExtention = (1 << 3) , IGFD_FileStyleByFullName = (1 << 4) , IGFD_FileStyleByContainedInFullName = (1 << 5) }
enum	ImGuiFileDialogFlags_ {   ImGuiFileDialogFlags_None = 0 , ImGuiFileDialogFlags_ConfirmOverwrite = (1 << 0) , ImGuiFileDialogFlags_DontShowHiddenFiles = (1 << 1) , ImGuiFileDialogFlags_DisableCreateDirectoryButton = (1 << 2) ,   ImGuiFileDialogFlags_HideColumnType = (1 << 3) , ImGuiFileDialogFlags_HideColumnSize = (1 << 4) , ImGuiFileDialogFlags_HideColumnDate = (1 << 5) , ImGuiFileDialogFlags_NoDialog = (1 << 6) ,   ImGuiFileDialogFlags_ReadOnlyFileNameField = (1 << 7) , ImGuiFileDialogFlags_CaseInsensitiveExtentionFiltering = (1 << 8) , ImGuiFileDialogFlags_Modal = (1 << 9) , ImGuiFileDialogFlags_DisableThumbnailMode = (1 << 10) ,   ImGuiFileDialogFlags_DisablePlaceMode = (1 << 11) , ImGuiFileDialogFlags_DisableQuickPathSelection = (1 << 12) , ImGuiFileDialogFlags_ShowDevicesButton = (1 << 13) , ImGuiFileDialogFlags_NaturalSorting = (1 << 14) ,   ImGuiFileDialogFlags_OptionalFileName = (1 << 15) , ImGuiFileDialogFlags_Default }
enum	IGFD_ResultMode_ { IGFD_ResultMode_AddIfNoFileExt = 0 , IGFD_ResultMode_OverwriteFileExt = 1 , IGFD_ResultMode_KeepInputFile = 2 }

Functions
IGFD_C_API struct IGFD_FileDialog_Config	IGFD_FileDialog_Config_Get ()
IGFD_C_API IGFD_Selection_Pair	IGFD_Selection_Pair_Get ()
IGFD_C_API void	IGFD_Selection_Pair_DestroyContent (IGFD_Selection_Pair *vSelection_Pair)
IGFD_C_API IGFD_Selection	IGFD_Selection_Get ()
IGFD_C_API void	IGFD_Selection_DestroyContent (IGFD_Selection *vSelection)
IGFD_C_API ImGuiFileDialog *	IGFD_Create (void)
IGFD_C_API void	IGFD_Destroy (ImGuiFileDialog *vContextPtr)
IGFD_C_API void	IGFD_OpenDialog (ImGuiFileDialog *vContextPtr, const char *vKey, const char *vTitle, const char *vFilters, const struct IGFD_FileDialog_Config vConfig)
IGFD_C_API bool	IGFD_DisplayDialog (ImGuiFileDialog *vContextPtr, const char *vKey, ImGuiWindowFlags vFlags, ImVec2 vMinSize, ImVec2 vMaxSize)
IGFD_C_API void	IGFD_CloseDialog (ImGuiFileDialog *vContextPtr)
IGFD_C_API bool	IGFD_IsOk (ImGuiFileDialog *vContextPtr)
IGFD_C_API bool	IGFD_WasKeyOpenedThisFrame (ImGuiFileDialog *vContextPtr, const char *vKey)
IGFD_C_API bool	IGFD_WasOpenedThisFrame (ImGuiFileDialog *vContextPtr)
IGFD_C_API bool	IGFD_IsKeyOpened (ImGuiFileDialog *vContextPtr, const char *vCurrentOpenedKey)
IGFD_C_API bool	IGFD_IsOpened (ImGuiFileDialog *vContextPtr)
IGFD_C_API IGFD_Selection	IGFD_GetSelection (ImGuiFileDialog *vContextPtr, IGFD_ResultMode vMode)
IGFD_C_API char *	IGFD_GetFilePathName (ImGuiFileDialog *vContextPtr, IGFD_ResultMode vMode)
IGFD_C_API char *	IGFD_GetCurrentFileName (ImGuiFileDialog *vContextPtr, IGFD_ResultMode vMode)
IGFD_C_API char *	IGFD_GetCurrentPath (ImGuiFileDialog *vContextPtr)
IGFD_C_API char *	IGFD_GetCurrentFilter (ImGuiFileDialog *vContextPtr)
IGFD_C_API void *	IGFD_GetUserDatas (ImGuiFileDialog *vContextPtr)
IGFD_C_API void	IGFD_SetFileStyle (ImGuiFileDialog *vContextPtr, IGFD_FileStyleFlags vFileStyleFlags, const char *vFilter, ImVec4 vColor, const char *vIconText, ImFont *vFont)
IGFD_C_API void	IGFD_SetFileStyle2 (ImGuiFileDialog *vContextPtr, IGFD_FileStyleFlags vFileStyleFlags, const char *vFilter, float vR, float vG, float vB, float vA, const char *vIconText, ImFont *vFont)
IGFD_C_API bool	IGFD_GetFileStyle (ImGuiFileDialog *vContextPtr, IGFD_FileStyleFlags vFileStyleFlags, const char *vFilter, ImVec4 *vOutColor, char **vOutIconText, ImFont **vOutFont)
IGFD_C_API void	IGFD_ClearFilesStyle (ImGuiFileDialog *vContextPtr)
IGFD_C_API void	SetLocales (ImGuiFileDialog *vContextPtr, const int vCategory, const char *vBeginLocale, const char *vEndLocale)

Macro Definition Documentation

IGFD_API

#define IGFD_API

IGFD_C_API

#define IGFD_C_API

IGFD_IMGUI_SUPPORTED_VERSION

#define IGFD_IMGUI_SUPPORTED_VERSION   "1.92.3"

IGFD_VERSION

#define IGFD_VERSION   "v0.6.9 WIP"

Typedef Documentation

IGFD_FileStyleFlags

typedef int IGFD_FileStyleFlags

IGFD_PaneFun

typedef void(* IGFD_PaneFun) (const char *, void *, bool *)

IGFD_ResultMode

typedef int IGFD_ResultMode

IGFD_Selection

typedef struct IGFD_Selection IGFD_Selection

IGFD_Selection_Pair

typedef struct IGFD_Selection_Pair IGFD_Selection_Pair

ImGuiFileDialog

typedef struct ImGuiFileDialog ImGuiFileDialog

ImGuiFileDialogFlags

typedef int ImGuiFileDialogFlags

Enumeration Type Documentation

IGFD_FileStyleFlags_

enum IGFD_FileStyleFlags_

Enumerator
IGFD_FileStyle_None
IGFD_FileStyleByTypeFile
IGFD_FileStyleByTypeDir
IGFD_FileStyleByTypeLink
IGFD_FileStyleByExtention
IGFD_FileStyleByFullName
IGFD_FileStyleByContainedInFullName

IGFD_ResultMode_

enum IGFD_ResultMode_

Enumerator
IGFD_ResultMode_AddIfNoFileExt
IGFD_ResultMode_OverwriteFileExt
IGFD_ResultMode_KeepInputFile

ImGuiFileDialogFlags_

enum ImGuiFileDialogFlags_

Enumerator
ImGuiFileDialogFlags_None
ImGuiFileDialogFlags_ConfirmOverwrite
ImGuiFileDialogFlags_DontShowHiddenFiles
ImGuiFileDialogFlags_DisableCreateDirectoryButton
ImGuiFileDialogFlags_HideColumnType
ImGuiFileDialogFlags_HideColumnSize
ImGuiFileDialogFlags_HideColumnDate
ImGuiFileDialogFlags_NoDialog
ImGuiFileDialogFlags_ReadOnlyFileNameField
ImGuiFileDialogFlags_CaseInsensitiveExtentionFiltering
ImGuiFileDialogFlags_Modal
ImGuiFileDialogFlags_DisableThumbnailMode
ImGuiFileDialogFlags_DisablePlaceMode
ImGuiFileDialogFlags_DisableQuickPathSelection
ImGuiFileDialogFlags_ShowDevicesButton
ImGuiFileDialogFlags_NaturalSorting
ImGuiFileDialogFlags_OptionalFileName
ImGuiFileDialogFlags_Default

Function Documentation

IGFD_ClearFilesStyle()

IGFD_C_API void IGFD_ClearFilesStyle

(

ImGuiFileDialog *

vContextPtr

)

IGFD_CloseDialog()

IGFD_C_API void IGFD_CloseDialog

(

ImGuiFileDialog *

vContextPtr

)

IGFD_Create()

IGFD_C_API ImGuiFileDialog * IGFD_Create

(

void

)

IGFD_Destroy()

IGFD_C_API void IGFD_Destroy

(

ImGuiFileDialog *

vContextPtr

)

IGFD_DisplayDialog()

IGFD_C_API bool IGFD_DisplayDialog	(	ImGuiFileDialog *	vContextPtr,
		const char *	vKey,
		ImGuiWindowFlags	vFlags,
		ImVec2	vMinSize,
		ImVec2	vMaxSize )

IGFD_FileDialog_Config_Get()

IGFD_C_API struct IGFD_FileDialog_Config IGFD_FileDialog_Config_Get

(

)

IGFD_GetCurrentFileName()

IGFD_C_API char * IGFD_GetCurrentFileName	(	ImGuiFileDialog *	vContextPtr,
		IGFD_ResultMode	vMode )

IGFD_GetCurrentFilter()

IGFD_C_API char * IGFD_GetCurrentFilter

(

ImGuiFileDialog *

vContextPtr

)

IGFD_GetCurrentPath()

IGFD_C_API char * IGFD_GetCurrentPath

(

ImGuiFileDialog *

vContextPtr

)

IGFD_GetFilePathName()

IGFD_C_API char * IGFD_GetFilePathName	(	ImGuiFileDialog *	vContextPtr,
		IGFD_ResultMode	vMode )

IGFD_GetFileStyle()

IGFD_C_API bool IGFD_GetFileStyle	(	ImGuiFileDialog *	vContextPtr,
		IGFD_FileStyleFlags	vFileStyleFlags,
		const char *	vFilter,
		ImVec4 *	vOutColor,
		char **	vOutIconText,
		ImFont **	vOutFont )

IGFD_GetSelection()

IGFD_C_API IGFD_Selection IGFD_GetSelection	(	ImGuiFileDialog *	vContextPtr,
		IGFD_ResultMode	vMode )

IGFD_GetUserDatas()

IGFD_C_API void * IGFD_GetUserDatas

(

ImGuiFileDialog *

vContextPtr

)

IGFD_IsKeyOpened()

IGFD_C_API bool IGFD_IsKeyOpened	(	ImGuiFileDialog *	vContextPtr,
		const char *	vCurrentOpenedKey )

IGFD_IsOk()

IGFD_C_API bool IGFD_IsOk

(

ImGuiFileDialog *

vContextPtr

)

IGFD_IsOpened()

IGFD_C_API bool IGFD_IsOpened

(

ImGuiFileDialog *

vContextPtr

)

IGFD_OpenDialog()

IGFD_C_API void IGFD_OpenDialog	(	ImGuiFileDialog *	vContextPtr,
		const char *	vKey,
		const char *	vTitle,
		const char *	vFilters,
		const struct IGFD_FileDialog_Config	vConfig )

IGFD_Selection_DestroyContent()

IGFD_C_API void IGFD_Selection_DestroyContent

(

IGFD_Selection *

vSelection

)

IGFD_Selection_Get()

IGFD_C_API IGFD_Selection IGFD_Selection_Get

(

)

IGFD_Selection_Pair_DestroyContent()

IGFD_C_API void IGFD_Selection_Pair_DestroyContent

(

IGFD_Selection_Pair *

vSelection_Pair

)

IGFD_Selection_Pair_Get()

IGFD_C_API IGFD_Selection_Pair IGFD_Selection_Pair_Get

(

)

IGFD_SetFileStyle()

IGFD_C_API void IGFD_SetFileStyle	(	ImGuiFileDialog *	vContextPtr,
		IGFD_FileStyleFlags	vFileStyleFlags,
		const char *	vFilter,
		ImVec4	vColor,
		const char *	vIconText,
		ImFont *	vFont )

IGFD_SetFileStyle2()

IGFD_C_API void IGFD_SetFileStyle2	(	ImGuiFileDialog *	vContextPtr,
		IGFD_FileStyleFlags	vFileStyleFlags,
		const char *	vFilter,
		float	vR,
		float	vG,
		float	vB,
		float	vA,
		const char *	vIconText,
		ImFont *	vFont )

IGFD_WasKeyOpenedThisFrame()

IGFD_C_API bool IGFD_WasKeyOpenedThisFrame	(	ImGuiFileDialog *	vContextPtr,
		const char *	vKey )

IGFD_WasOpenedThisFrame()

IGFD_C_API bool IGFD_WasOpenedThisFrame

(

ImGuiFileDialog *

vContextPtr

)

SetLocales()

IGFD_C_API void SetLocales	(	ImGuiFileDialog *	vContextPtr,
		const int	vCategory,
		const char *	vBeginLocale,
		const char *	vEndLocale )