1
0
mirror of synced 2025-02-03 04:47:10 +01:00
ImHex/plugins/builtin/source/content/views/view_tutorials.cpp

76 lines
3.0 KiB
C++
Raw Normal View History

2023-12-13 13:04:59 +01:00
#include "content/views/view_tutorials.hpp"
#include <hex/api/content_registry.hpp>
#include <hex/api/tutorial_manager.hpp>
#include <hex/api/task_manager.hpp>
impr: Refactor and restructure Event Manager (#2082) ### Problem description This PR addresses issue #2013 that described a cluttered Event Manager. This is a DX issue and should not impact the users whatsoever. ### Implementation description The changes revolve around three main points: 1. the Event Manager (`event_manager.hpp`) was split into four categories: GUI, Interaction, Lifecycle, and Provider, and two types: Events, and Requests. This results in the following files: - `events_gui.hpp` - `events_interaction.hpp` - `events_lifecycle.hpp` - `events_provider.hpp` - `requests_gui.hpp` - `requests_interaction.hpp` - `requests_lifecycle.hpp` - `requests_provider.hpp` 2. Every event and request now has its own piece of documentation, with a `@brief`, accompanied by a longer comment if needed, and gets its `@param`s described. 3. The old `event_manager.hpp` import was removed and replaced by the correct imports wherever needed, as to reduce spread of those files only to where they are truly useful. ### Additional things The commits have been split into (chrono-)logical steps: - `feat`: split the Event Manager, and replace the imports - `refactor`, `chore`: make various small changes to match the required structure - `docs`: add documentation for events and requests Hopefully, this will help to review the PR. *Note: Beware of very long rebuild times in between the commits, use them sparingly! The Actions will ensure this PR builds anyways* Closes #2013 --------- Signed-off-by: BioTheWolff <47079795+BioTheWolff@users.noreply.github.com> Co-authored-by: Nik <werwolv98@gmail.com>
2025-01-25 16:32:07 +01:00
#include <hex/api/events/requests_gui.hpp>
2023-12-13 13:04:59 +01:00
2024-12-14 20:36:09 +01:00
#include <fonts/vscode_icons.hpp>
2023-12-13 13:04:59 +01:00
#include <ranges>
namespace hex::plugin::builtin {
ViewTutorials::ViewTutorials() : View::Floating("hex.builtin.view.tutorials.name") {
2024-01-08 21:51:48 +01:00
ContentRegistry::Interface::addMenuItem({ "hex.builtin.menu.help", "hex.builtin.view.tutorials.name" }, ICON_VS_COMPASS, 4000, Shortcut::None, [&, this] {
2023-12-13 13:04:59 +01:00
this->getWindowOpenState() = true;
});
RequestOpenWindow::subscribe(this, [this](const std::string &name) {
if (name == "Tutorials") {
TaskManager::doLater([this] {
this->getWindowOpenState() = true;
});
}
});
2023-12-13 13:04:59 +01:00
}
void ViewTutorials::drawContent() {
const auto& tutorials = TutorialManager::getTutorials();
const auto& currTutorial = TutorialManager::getCurrentTutorial();
if (ImGui::BeginTable("TutorialLayout", 2, ImGuiTableFlags_SizingFixedFit)) {
ImGui::TableSetupColumn("Name", ImGuiTableColumnFlags_WidthStretch, 0.3F);
ImGui::TableSetupColumn("Description", ImGuiTableColumnFlags_WidthStretch, 0.7F);
ImGui::TableNextRow();
ImGui::TableNextColumn();
if (ImGui::BeginTable("Tutorials", 1, ImGuiTableFlags_Borders | ImGuiTableFlags_RowBg, ImGui::GetContentRegionAvail())) {
for (const auto &tutorial : tutorials | std::views::values) {
2023-12-19 13:10:25 +01:00
if (m_selectedTutorial == nullptr)
m_selectedTutorial = &tutorial;
2023-12-13 13:04:59 +01:00
ImGui::TableNextRow();
ImGui::TableNextColumn();
2023-12-19 13:10:25 +01:00
if (ImGui::Selectable(Lang(tutorial.getUnlocalizedName()), m_selectedTutorial == &tutorial, ImGuiSelectableFlags_SpanAllColumns)) {
m_selectedTutorial = &tutorial;
2023-12-13 13:04:59 +01:00
}
}
ImGui::EndTable();
}
ImGui::TableNextColumn();
2023-12-19 13:10:25 +01:00
if (m_selectedTutorial != nullptr) {
if (ImGuiExt::BeginSubWindow("hex.builtin.view.tutorials.description"_lang, nullptr, ImGui::GetContentRegionAvail() - ImVec2(0, ImGui::GetTextLineHeightWithSpacing() + ImGui::GetStyle().ItemSpacing.y * 2))) {
2023-12-19 13:10:25 +01:00
ImGuiExt::TextFormattedWrapped(Lang(m_selectedTutorial->getUnlocalizedDescription()));
2023-12-13 13:04:59 +01:00
}
ImGuiExt::EndSubWindow();
2023-12-13 13:04:59 +01:00
ImGui::BeginDisabled(currTutorial != tutorials.end());
if (ImGuiExt::DimmedButton("hex.builtin.view.tutorials.start"_lang, ImVec2(ImGui::GetContentRegionAvail().x, 0))) {
2023-12-19 13:10:25 +01:00
TutorialManager::startTutorial(m_selectedTutorial->getUnlocalizedName());
this->getWindowOpenState() = false;
2023-12-13 13:04:59 +01:00
}
ImGui::EndDisabled();
}
ImGui::EndTable();
}
}
}