b646ece14b
### 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>
38 lines
872 B
C++
38 lines
872 B
C++
#pragma once
|
|
|
|
#include <hex/api/event_manager.hpp>
|
|
|
|
/* GUI requests definitions */
|
|
namespace hex {
|
|
|
|
/**
|
|
* @brief Requests the opening of a new window.
|
|
*
|
|
* @param name the window's name
|
|
*/
|
|
EVENT_DEF(RequestOpenWindow, std::string);
|
|
|
|
/**
|
|
* @brief Centralized request to update ImHex's main window title
|
|
*
|
|
* This request can be called to make ImHex refresh its main window title, taking into account a new project
|
|
* or file opened/closed.
|
|
*/
|
|
EVENT_DEF(RequestUpdateWindowTitle);
|
|
|
|
/**
|
|
* @brief Requests a theme type (light or dark) change
|
|
*
|
|
* @param themeType either `Light` or `Dark`
|
|
*/
|
|
EVENT_DEF(RequestChangeTheme, std::string);
|
|
|
|
/**
|
|
* @brief Requests the opening of a popup
|
|
*
|
|
* @param name the popup's name
|
|
*/
|
|
EVENT_DEF(RequestOpenPopup, std::string);
|
|
|
|
}
|