Skip to content

Commit

Permalink
[UPD] : update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aiekick committed Feb 21, 2024
1 parent 79a4153 commit a201273
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion ImGuiFileDialog
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,14 @@ Android Requirements : Api 21 mini
- 0 => Infinite
- 1 => One file (default)
- n => n files
- Compatible with MacOs, Linux, Windows, Emscripten
- Windows version can list drives
- Compatible with MacOs, Linux, Windows, Emscripten, Android
- Supports modal or standard dialog types
- Select files or directories
- Filter groups and custom filter names
- can ignore filter Case for file searching
- Keyboard navigation (arrows, backspace, enter)
- Exploring by entering characters (case insensitive)
- Custom places (bookmarks, devices, whatever you want)
- Custom places (bookmarks, system devices, whatever you want)
- Directory manual entry (right click on any path element)
- Optional 'Confirm to Overwrite" dialog if file exists
- Thumbnails Display (agnostic way for compatibility with any backend, sucessfully tested with OpenGl and Vulkan)
Expand Down Expand Up @@ -520,15 +519,19 @@ the DemoApp branch with the "quick access" paths of win10
You must add a group first, then add a place to it :

```cpp
// you must add a group first, specifu display order, and say if the user can add or remove palce like (bookmarks)
ImGuiFileDialog::Instance()->AddPlacesGroup(group_name, display_order, can_be_user_edited);
// you must add a group first, specifu display order, and say :
// if the user can add or remove palce like (bookmarks)
// if the group is opened by default
ImGuiFileDialog::Instance()->AddPlacesGroup(group_name, display_order, can_be_user_edited, opened_by_default);
// then you must get the group
auto places_ptr = ImGuiFileDialog::Instance()->GetPlacesGroupPtr(group_name);
if (places_ptr != nullptr) {
// then add a place to the group
// you msut specify the place name, the palce path, say if the palce can be serialized, and sepcify the style
// for the moment the style support only the icon, can be extended if user needed in futur
places_ptr->AddPlace(place_name, place_path, can_be_saved, style);
places_ptr->AddPlace(place_name, place_path, can_be_saved, style);
// you can also add a separator
places_ptr->AddPlaceSeparator(separator_thickness);
}
```
Expand Down

0 comments on commit a201273

Please sign in to comment.