Add IniFolderType.AbsolutePath

pthom · Jun 25, 2024 · 162ca62 · 162ca62
1 parent 218ea3c
commit 162ca62
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/hello_imgui/doc_api.md b/src/hello_imgui/doc_api.md
@@ -326,7 +326,7 @@ std::string    CurrentLayoutName();
 
 ```cpp
 
-// IniFolderType is an enum which describle where is the base path to store
+// IniFolderType is an enum which describes where is the base path to store
 // the ini file for the application settings.
 //
 // You can use IniFolderLocation(iniFolderType) to get the corresponding path.
@@ -348,6 +348,10 @@ enum class IniFolderType
     // (convenient for development, but not recommended for production)
     CurrentFolder,
 
+    // AbsolutePath: an absolute path
+    // (convenient, but not recommended if targeting multiple platforms)
+    AbsolutePath,
+
     // AppUserConfigFolder:
     //      AppData under Windows (Example: C:\Users\[Username]\AppData\Roaming under windows)
     //      ~/.config under Linux

diff --git a/src/hello_imgui/internal/platform/ini_folder_locations.cpp b/src/hello_imgui/internal/platform/ini_folder_locations.cpp
@@ -240,6 +240,8 @@ namespace HelloImGui
         {
             case IniFolderType::CurrentFolder:
                 return "";
+            case IniFolderType::AbsolutePath:
+                return "";
             case IniFolderType::AppUserConfigFolder:
                 return GetAppUserConfigFolder();
             case IniFolderType::DocumentsFolder:

diff --git a/src/hello_imgui/runner_params.h b/src/hello_imgui/runner_params.h
@@ -48,7 +48,7 @@ enum class RendererBackendType
 
 // @@md#IniFolderType
 
-// IniFolderType is an enum which describle where is the base path to store
+// IniFolderType is an enum which describes where is the base path to store
 // the ini file for the application settings.
 //
 // You can use IniFolderLocation(iniFolderType) to get the corresponding path.
@@ -70,6 +70,10 @@ enum class IniFolderType
     // (convenient for development, but not recommended for production)
     CurrentFolder,
 
+    // AbsolutePath: an absolute path
+    // (convenient, but not recommended if targeting multiple platforms)
+    AbsolutePath,
+
     // AppUserConfigFolder:
     //      AppData under Windows (Example: C:\Users\[Username]\AppData\Roaming under windows)
     //      ~/.config under Linux