can explore by keys / up / down / enter / backspace

can explore by input char also
better fps by display only pre filtered file list (search tag)
use now virtual list mode also for big file list
keep cycles to the minimum needed
update readme with a gif for explain the new features

Author: aiekick

3rdparty/imgui

@@ -4,10 +4,15 @@
 
 //#define USE_IMGUI_TABLES
 
+#define USE_EXPLORATION_BY_KEYS
 #include <GLFW/glfw3.h>
+// Up key for explore to the top
 #define IGFD_KEY_UP GLFW_KEY_UP
+// Down key for explore to the bottom
 #define IGFD_KEY_DOWN GLFW_KEY_DOWN
+// Enter key for open directory
 #define IGFD_KEY_ENTER GLFW_KEY_ENTER
+// BackSpace for comming back to the last directory
 #define IGFD_KEY_BACKSPACE GLFW_KEY_BACKSPACE
 
 // widget

CustomImGuiFileDialogConfig.h

@@ -341,7 +341,7 @@ namespace igfd
 	//////////////////////////////////////////////////////////////////////////////////////////////////
 	///// CUSTOM SELECTABLE (Flashing Support) ///////////////////////////////////////////////////////
 	//////////////////////////////////////////////////////////////////////////////////////////////////
-	
+#ifdef USE_EXPLORATION_BY_KEYS
 	bool ImGuiFileDialog::FlashableSelectable(const char* label, bool selected, 
 		ImGuiSelectableFlags flags, bool vFlashing, const ImVec2& size_arg)
 	{
@@ -466,6 +466,7 @@ namespace igfd
 		IMGUI_TEST_ENGINE_ITEM_INFO(id, label, window->DC.ItemFlags);
 		return pressed;
 	}
+#endif
 
 	//////////////////////////////////////////////////////////////////////////////////////////////////
 	///// STANDARD DIALOG ////////////////////////////////////////////////////////////////////////////
@@ -882,8 +883,8 @@ namespace igfd
 	#endif
 #endif
                 size_t countRows = m_FilteredFileList.size();
-                ImGuiListClipper clipper(countRows, ImGui::GetFrameHeight());
-                for(int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
+                ImGuiListClipper clipper(countRows, ImGui::GetTextLineHeightWithSpacing());
+				 for(int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++)
                 {
                     const FileInfoStruct& infos = m_FilteredFileList[i];
 
@@ -915,12 +916,16 @@ namespace igfd
 #ifdef USE_IMGUI_TABLES
                     selectableFlags |= ImGuiSelectableFlags_SpanAllColumns;
 #endif
+					bool _selectablePressed = false;
+#ifdef USE_EXPLORATION_BY_KEYS
                     LocateByInputKey();
-                    bool _selectablePressed = false;
-                    bool flashed = BeginFlashItem(i);
-                    _selectablePressed = FlashableSelectable(str.c_str(), selected, selectableFlags, flashed);
+					bool flashed = BeginFlashItem(i);
+					 _selectablePressed = FlashableSelectable(str.c_str(), selected, selectableFlags, flashed);
                     if (flashed)
                         EndFlashItem();
+#else
+					_selectablePressed = ImGui::Selectable(str.c_str(), selected, selectableFlags);
+#endif
                     if (_selectablePressed)
                     {
                         if (infos.type == 'd')
@@ -968,9 +973,9 @@ namespace igfd
 				}
 				ImGui::EndTable();
 #endif
-
+#ifdef USE_EXPLORATION_BY_KEYS
 				ExploreWithkeys(); // outside of file list loop
-
+#endif
 				// changement de repertoire
 				if (pathClick)
 				{
@@ -1665,9 +1670,10 @@ namespace igfd
 				}
 				free(files);
 			}
+
+			SortFields(m_SortingField);
+			ApplyFilteringOnFileList();
 		}
-        SortFields(m_SortingField);
-        ApplyFilteringOnFileList();
 	}
 
 	void ImGuiFileDialog::SetCurrentDir(const std::string& vPath)
@@ -1939,57 +1945,75 @@ namespace igfd
 	////////////////////////////////////////////////////////////////////////////////////////////////
 
 	static size_t locateFileByInputChar_lastFileIdx = 0;
+	static char locateFileByInputChar_lastChar = 0;
+	static int locateFileByInputChar_InputQueueCharactersSize = 0;
+	static bool locateFileByInputChar_lastFound = false;
+
+	bool ImGuiFileDialog::LocateItem_Loop(char vC)
+	{
+		bool found = false;
+
+		for (size_t i = locateFileByInputChar_lastFileIdx; i < m_FilteredFileList.size(); i++)
+		{
+			if (m_FilteredFileList[i].fileName_optimized[0] == vC || // lower case search
+				m_FilteredFileList[i].fileName[0] == vC) // maybe upper case search
+			{
+				float p = (float)((double)i / (double)m_FilteredFileList.size()) * ImGui::GetScrollMaxY();
+				ImGui::SetScrollY(p);
+				found = true;
+				locateFileByInputChar_lastFound = true;
+				locateFileByInputChar_lastFileIdx = i;
+				StartFlashItem(locateFileByInputChar_lastFileIdx);
+
+				auto infos = &m_FilteredFileList[locateFileByInputChar_lastFileIdx];
+
+				if (infos->type == 'd')
+				{
+					if (!dlg_filters) // directory chooser
+					{
+						SelectFileName(*infos);
+					}
+				}
+				else
+				{
+					SelectFileName(*infos);
+				}
 
+				found = true;
+
+				break;
+			}
+		}
+
+		return found;
+	}
+
+#ifdef USE_EXPLORATION_BY_KEYS
 	void ImGuiFileDialog::LocateByInputKey()
 	{
 		ImGuiContext& g = *GImGui;
-		if (!g.ActiveId && !m_FileList.empty())
+		if (!g.ActiveId && !m_FilteredFileList.empty())
 		{
 			// point by char
-			static char locateFileByInputChar_lastChar = 0;
-			static int locateFileByInputChar_InputQueueCharactersSize = 0;
 			if (!ImGui::GetIO().InputQueueCharacters.empty())
 			{
 				char c = ImGui::GetIO().InputQueueCharacters.back();
-				if (locateFileByInputChar_InputQueueCharactersSize != ImGui::GetIO().InputQueueCharacters.size())
+				if (locateFileByInputChar_InputQueueCharactersSize != 
+					ImGui::GetIO().InputQueueCharacters.size())
 				{
 					if (c == locateFileByInputChar_lastChar) // next file starting with same char until
 					{
-						if (locateFileByInputChar_lastFileIdx < m_FileList.size() - 1)
+						if (locateFileByInputChar_lastFileIdx < m_FilteredFileList.size() - 1)
 							locateFileByInputChar_lastFileIdx++;
 						else
 							locateFileByInputChar_lastFileIdx = 0;
 					}
-					else // new char
-					{
-						locateFileByInputChar_lastFileIdx = 0;
-					}
 
-					static bool locateFileByInputChar_lastFound = false;
-					bool found = false;
-					for (size_t i = locateFileByInputChar_lastFileIdx; i < m_FileList.size(); i++)
+					if (!LocateItem_Loop(c))
 					{
-						if (m_FileList[i].fileName_optimized[0] == c || // lower case search
-							m_FileList[i].fileName[0] == c) // maybe upper case search
-						{
-							float p = (float)((double)i / (double)m_FileList.size()) * ImGui::GetScrollMaxY();
-							ImGui::SetScrollY(p);
-							found = true;
-							locateFileByInputChar_lastFound = true;
-							locateFileByInputChar_lastFileIdx = i;
-							StartFlashItem(locateFileByInputChar_lastFileIdx);
-							break;
-						}
-						
-						if (c == locateFileByInputChar_lastChar && 
-							locateFileByInputChar_lastFound && 
-							!found && 
-							i == m_FileList.size() - 1) //last item and not found => new loop
-						{
-							locateFileByInputChar_lastFileIdx = 0; // cyclic next file starting with same char until
-							i = 0;
-							locateFileByInputChar_lastFound = false;
-						}
+						// not found, loop again from 0 this time
+						locateFileByInputChar_lastFileIdx = 0;
+						LocateItem_Loop(c);
 					}
 
 					locateFileByInputChar_lastChar = c;
@@ -2002,24 +2026,24 @@ namespace igfd
 	void ImGuiFileDialog::ExploreWithkeys()
 	{
         ImGuiContext& g = *GImGui;
-        if (!g.ActiveId && !m_FileList.empty())
+        if (!g.ActiveId && !m_FilteredFileList.empty())
         {
             // explore
             bool exploreByKey = false;
             bool enterInDirectory = false;
             bool exitDirectory = false;
-            if (ImGui::IsKeyReleased(IGFD_KEY_UP))
+            if (ImGui::IsKeyPressed(IGFD_KEY_UP))
             {
                 exploreByKey = true;
                 if (locateFileByInputChar_lastFileIdx > 0)
                 {
                     locateFileByInputChar_lastFileIdx--;
                 }
             }
-            else if (ImGui::IsKeyReleased(IGFD_KEY_DOWN))
+            else if (ImGui::IsKeyPressed(IGFD_KEY_DOWN))
             {
                 exploreByKey = true;
-                if (locateFileByInputChar_lastFileIdx < m_FileList.size() - 1)
+                if (locateFileByInputChar_lastFileIdx < m_FilteredFileList.size() - 1)
                 {
                     locateFileByInputChar_lastFileIdx++;
                 }
@@ -2037,11 +2061,11 @@ namespace igfd
 
             if (exploreByKey)
             {
-                float p = (float)((double)locateFileByInputChar_lastFileIdx / (double)m_FileList.size()) * ImGui::GetScrollMaxY();
+                float p = (float)((double)locateFileByInputChar_lastFileIdx / (double)m_FilteredFileList.size()) * ImGui::GetScrollMaxY();
                 ImGui::SetScrollY(p);
                 StartFlashItem(locateFileByInputChar_lastFileIdx);
 
-                auto infos = &m_FileList[locateFileByInputChar_lastFileIdx];
+                auto infos = &m_FilteredFileList[locateFileByInputChar_lastFileIdx];
 
                 if (infos->type == 'd')
                 {
@@ -2079,7 +2103,7 @@ namespace igfd
                     {
                         // changement de repertoire
                         SetPath(m_CurrentPath);
-                        if (locateFileByInputChar_lastFileIdx > m_FileList.size() - 1)
+                        if (locateFileByInputChar_lastFileIdx > m_FilteredFileList.size() - 1)
                         {
                             locateFileByInputChar_lastFileIdx = 0;
                         }
@@ -2111,7 +2135,7 @@ namespace igfd
 		if (m_FlashedItem == vIdx && 
 			std::abs(m_FlashAlpha - 0.0f) > 0.00001f)
 		{
-			m_FlashAlpha -= m_FlashAlphaStep;
+			m_FlashAlpha -= m_FlashAlphaAttenInSecs * ImGui::GetIO().DeltaTime;
 			if (m_FlashAlpha < 0.0f) m_FlashAlpha = 0.0f;
 
 			ImVec4 hov = ImGui::GetStyleColorVec4(ImGuiCol_HeaderHovered);
@@ -2127,5 +2151,11 @@ namespace igfd
 	{
 		ImGui::PopStyleColor();
 	}
+
+	void ImGuiFileDialog::SetFlashingAttenuationInSeconds(float vAttenValue)
+	{
+		m_FlashAlphaAttenInSecs = 1.0f / max(vAttenValue,0.01f);
+	}
+#endif
 }
 

ImGuiFileDialog/ImGuiFileDialog.cpp

@@ -24,7 +24,7 @@ SOFTWARE.
 
 #pragma once
 
-#define IMGUIFILEDIALOG_VERSION "v0.2"
+#define IMGUIFILEDIALOG_VERSION "v0.3"
 
 #include <imgui.h>
 
@@ -64,15 +64,13 @@ namespace igfd
 		size_t fileSize = 0; // for sorting operations
 		std::string formatedFileSize;
 		std::string fileModifDate;
-
 	};
 
 	// old FilterInfosStruct
 	struct FileExtentionInfosStruct
 	{
 		std::string icon;
 		ImVec4 color = ImVec4(0, 0, 0, 0);
-
 		FileExtentionInfosStruct() { color = ImVec4(0, 0, 0, 0); }
 		FileExtentionInfosStruct(const ImVec4& vColor, const std::string& vIcon = std::string())
 		{
@@ -109,7 +107,7 @@ namespace igfd
 
 	enum SortingFieldEnum
     {
-        FIELD_NONE=0,
+		FIELD_NONE = 0,
 	    FIELD_FILENAME,
 	    FIELD_SIZE,
 		FIELD_DATE
@@ -134,7 +132,7 @@ namespace igfd
 	private: // flash when select by char
 		size_t m_FlashedItem = 0;
 		float m_FlashAlpha = 0.0f;
-		float m_FlashAlphaStep = 0.01f; // fps display dependant
+		float m_FlashAlphaAttenInSecs = 1.0f; // fps display dependant
 
 	public:
 		static char FileNameBuffer[MAX_FILE_DIALOG_NAME_BUFFER];
@@ -210,6 +208,7 @@ namespace igfd
 			const std::string& vFilePathName, const int& vCountSelectionMax = 1,
 			UserDatas vUserDatas = 0);
 
+	public: // core
 		bool FileDialog(const std::string& vKey, ImGuiWindowFlags vFlags = ImGuiWindowFlags_NoCollapse,
 			ImVec2 vMinSize = ImVec2(0, 0), ImVec2 vMaxSize = ImVec2(FLT_MAX, FLT_MAX));
 		void CloseDialog(const std::string& vKey);
@@ -246,13 +245,18 @@ namespace igfd
 	private:
 	    void ApplyFilteringOnFileList();
 
+#ifdef USE_EXPLORATION_BY_KEYS
 	private: // file localization by input chat // widget flashing
 		void LocateByInputKey();
+		bool LocateItem_Loop(char vC);
 		void ExploreWithkeys();
 		static bool FlashableSelectable(const char* label, bool selected = false, ImGuiSelectableFlags flags = 0,
 			bool vFlashing = false, const ImVec2& size = ImVec2(0, 0));
 		void StartFlashItem(size_t vIdx);
 		bool BeginFlashItem(size_t vIdx);
 		void EndFlashItem();
+	public:
+		void SetFlashingAttenuationInSeconds(float vAttenValue);
+#endif
 	};
 }

ImGuiFileDialog/ImGuiFileDialog.h

@@ -4,10 +4,16 @@
 
 //#define USE_IMGUI_TABLES
 
-//#include <GLFW/glfw3.h>
+//#define USE_EXPLORATION_BY_KEYS
+// this mapping by default is for GLFW but you can use another
+//#include <GLFW/glfw3.h> 
+// Up key for explore to the top
 //#define IGFD_KEY_UP GLFW_KEY_UP
+// Down key for explore to the bottom
 //#define IGFD_KEY_DOWN GLFW_KEY_DOWN
+// Enter key for open directory
 //#define IGFD_KEY_ENTER GLFW_KEY_ENTER
+// BackSpace for comming back to the last directory
 //#define IGFD_KEY_BACKSPACE GLFW_KEY_BACKSPACE
 
 // widget

ImGuiFileDialog/ImGuiFileDialogConfig.h

@@ -18,6 +18,8 @@ An example of the File Dialog integrated within the ImGui Demo App
 - Support of Modal/Standard dialog type
 - Support both Mode : File Chooser or Directory Chooser
 - Support filter collection / Custom filter name
+- Support files Exploring with keys : Up / Down / Enter (open dir) / Backspace (come back)
+- Support files Exploring by input char (case insensitive)
 
 Use the Namespace igfd (for avoid conflict with variables, struct and class names)
 
@@ -186,6 +188,25 @@ You can have tables display like that.
 
 ![alt text](doc/imgui_tables_branch.gif)
 
+## Exploring by keys
+
+you can activate this feature by uncomment "#define USE_EXPLORATION_BY_KEYS" in you custom config file (CustomImGuiFileDialogConfig.h in this example)
+you can also uncomment the next lines for define your keys :
+*IGFD_KEY_UP => Up key for explore to the top
+*IGFD_KEY_DOWN => Down key for explore to the bottom
+*IGFD_KEY_ENTER => Enter key for open directory
+*IGFD_KEY_BACKSPACE => BackSpace for comming back to the last directory
+
+you can also explore a file list by use the current key char.
+
+![alt text](doc/explore_ny_keys.gif)
+
+as you see the current item is flashed (by default for 1 sec)
+you can define the flashing life time by yourself with the function
+```cpp
+igfd::ImGuiFileDialog::Instance()->SetFlashingAttenuationInSeconds(1.0f);
+```
+
 ## How to Integrate ImGuiFileDialog in your porject
 
 ### ImGuiFileDialog require :