Code/Tools/Libs/GuiFoundation/UIServices/DynamicEnums.h - dev - redgpu/ezEngine

Code/Tools/Libs/GuiFoundation/UIServices/DynamicEnums.h

53 строки2 KB

Jan Krassnigg

DynamicEnums can show option to execute action to edit values (#1556)

13 май 2025, 20:58

13 май 2025, 20:58bbeb558

#pragma once

#include <Foundation/Containers/Map.h>
#include <Foundation/Strings/String.h>
#include <Foundation/Types/Variant.h>
#include <GuiFoundation/GuiFoundationDLL.h>

/// \brief Stores the valid values and names for 'dynamic' enums.
///
/// The names and valid values for dynamic enums may change due to user configuration changes.
/// The UI should show these user specified names without restarting the tool.
///
/// Call the static function GetDynamicEnum() to create or get the ezDynamicEnum for a specific type.
class EZ_GUIFOUNDATION_DLL ezDynamicEnum
{
public:
  /// \brief Returns a ezDynamicEnum under the given name. Creates a new one, if the name has not been used before.
  static ezDynamicEnum& GetDynamicEnum(const char* szEnumName);

  /// \brief Returns all enum values and current names.
  const ezMap<ezInt32, ezString>& GetAllValidValues() const { return m_ValidValues; }

  /// \brief Resets the internal data.
  void Clear();

  /// \brief Sets the name for the given enum value.
  void SetValueAndName(ezInt32 iValue, ezStringView sNewName);

  /// \brief Removes a certain enum value, if it exists.
  void RemoveValue(ezInt32 iValue);

  /// \brief Returns whether a certain value is known.
  bool IsValueValid(ezInt32 iValue) const;

  /// \brief Returns the name for the given value. Returns "<invalid value>" if the value is not in use.
  ezStringView GetValueName(ezInt32 iValue) const;

  /// \brief If specified, the widget shows an "edit" option, which will run ezActionManager::ExecuteAction(sCmd, value)
  ///
  /// This is meant to be used to open existing config dialogs.
  /// There is currently no way to report back a selection, so after making changes, the user has to make another selection.
  void SetEditCommand(ezStringView sCmd, const ezVariant& value);
  ezStringView GetEditCommand() const { return m_sEditCommand; }
  const ezVariant& GetEditCommandValue() const { return m_EditCommandValue; }


private:
  ezMap<ezInt32, ezString> m_ValidValues;
  ezString m_sEditCommand;
  ezVariant m_EditCommandValue;

  static ezMap<ezString, ezDynamicEnum> s_DynamicEnums;
};