Code/Editor/EditorFramework/PropertyGrid/Implementation/FileBrowserPropertyWidget.cpp - dev - redgpu/ezEngine

Code/Editor/EditorFramework/PropertyGrid/Implementation/FileBrowserPropertyWidget.cpp
446 строк14 KB
Jan Krassnigg
Introduced attribute to mark properties as required (#1981)
09 июл 2026, 19:48
09 июл 2026, 19:48111b7a7
#include <EditorFramework/EditorFrameworkPCH.h>

#include <EditorFramework/Assets/AssetBrowserDlg.moc.h>
#include <EditorFramework/EditorApp/EditorApp.moc.h>
#include <EditorFramework/PropertyGrid/FileBrowserPropertyWidget.moc.h>
#include <EditorFramework/PropertyGrid/QtFileLineEdit.moc.h>
#include <GuiFoundation/PropertyGrid/PropertyGridWidget.moc.h>

ezQtFilePropertyWidget::ezQtFilePropertyWidget()
  : ezQtStandardPropertyWidget()
{
  m_pLayout = new QHBoxLayout(this);
  m_pLayout->setContentsMargins(0, 0, 0, 0);
  setLayout(m_pLayout);

  m_pWidget = new ezQtFileLineEdit(this);
  m_pWidget->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Preferred);
  m_pWidget->setFocusPolicy(Qt::FocusPolicy::StrongFocus);
  setFocusProxy(m_pWidget);

  EZ_VERIFY(connect(m_pWidget, SIGNAL(editingFinished()), this, SLOT(on_TextFinished_triggered())) != nullptr, "signal/slot connection failed");
  EZ_VERIFY(connect(m_pWidget, SIGNAL(textChanged(const QString&)), this, SLOT(on_TextChanged_triggered(const QString&))) != nullptr, "signal/slot connection failed");

  m_pButton = new QToolButton(this);
  m_pButton->setText(QStringLiteral("... "));
  m_pButton->setToolButtonStyle(Qt::ToolButtonStyle::ToolButtonTextOnly);
  m_pButton->setPopupMode(QToolButton::ToolButtonPopupMode::InstantPopup);
  m_pButton->setContextMenuPolicy(Qt::ContextMenuPolicy::NoContextMenu);

  {
    QMenu* pMenu = new QMenu();

    pMenu->setDefaultAction(pMenu->addAction(QIcon(), QLatin1String("Select File"), this, SLOT(on_BrowseFile_clicked())));
    QAction* pActionOpenFile = pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/Document.svg")), QLatin1String("Open File"), this, SLOT(OnOpenFile()));
    QAction* pActionOpenWith = pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/Document.svg")), QLatin1String("Open With..."), this, SLOT(OnOpenFileWith()));

    pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/OpenFolder.svg")), QLatin1String("Open in Explorer"), this, SLOT(OnOpenExplorer()));

    connect(pMenu, &QMenu::aboutToShow, pMenu, [=]()
      {
        pActionOpenFile->setEnabled(!m_pWidget->text().isEmpty());
        pActionOpenWith->setEnabled(!m_pWidget->text().isEmpty());
        //
      });

    m_pButton->setMenu(pMenu);
  }

  m_pWarningIcon = new QLabel(this);
  m_pWarningIcon->setPixmap(ezQtUiServices::GetCachedIconResource(":/GuiFoundation/Icons/Warning.svg").pixmap(16, 16));
  m_pWarningIcon->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
  m_pWarningIcon->setVisible(false);
  m_pWarningIcon->setToolTip(QStringLiteral("This property is required and must reference a file."));

  m_pLayout->addWidget(m_pWidget);
  m_pLayout->addWidget(m_pButton);
  m_pLayout->addWidget(m_pWarningIcon);
}

void ezQtFilePropertyWidget::UpdateRequiredIndicator(bool bValueEmpty)
{
  const bool bRequired = m_pProp->GetAttributeByType<ezRequiredAttribute>() != nullptr;
  m_pWarningIcon->setVisible(bRequired && bValueEmpty);
}

bool ezQtFilePropertyWidget::IsValidFileReference(ezStringView sFile) const
{
  auto pAttr = m_pProp->GetAttributeByType<ezFileBrowserAttribute>();

  ezTempHybridArray<ezStringView, 8> extensions;
  ezStringView sTemp = pAttr->GetTypeFilter();
  sTemp.Split(false, extensions, ";");
  for (ezStringView& ext : extensions)
  {
    ext.TrimWordStart("*.");
    if (sFile.GetFileExtension().IsEqual_NoCase(ext))
      return true;
  }

  return false;
}

void ezQtFilePropertyWidget::SetReadOnly(bool bReadOnly /*= true*/)
{
  m_pWidget->setReadOnly(bReadOnly);
}

void ezQtFilePropertyWidget::OnInit()
{
  auto pAttr = m_pProp->GetAttributeByType<ezFileBrowserAttribute>();
  EZ_ASSERT_DEV(pAttr != nullptr, "ezQtFilePropertyWidget was created without a ezFileBrowserAttribute!");

  if (!pAttr->GetCreateTitle().IsEmpty())
  {
    m_pButton->menu()->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/DocumentAdd.svg")), QString("Create %1...").arg(ezMakeQString(pAttr->GetCreateTitle())), this, SLOT(OnCreateFile()));
  }

  if (!pAttr->GetCustomAction().IsEmpty())
  {
    m_pButton->menu()->addAction(QIcon(), ezMakeQString(ezTranslate(pAttr->GetCustomAction())), this, SLOT(OnCustomAction()));
  }
}

void ezQtFilePropertyWidget::InternalSetValue(const ezVariant& value)
{
  ezQtScopedBlockSignals b(m_pWidget);
  ezQtScopedBlockSignals b2(m_pButton);

  if (!value.IsValid())
  {
    m_pWidget->setPlaceholderText(QStringLiteral("<Multiple Values>"));
    m_pWarningIcon->setVisible(false);
  }
  else
  {
    ezStringBuilder sText = value.ConvertTo<ezString>();

    m_pWidget->setPlaceholderText(QString());
    m_pWidget->setText(QString::fromUtf8(sText.GetData()));

    UpdateRequiredIndicator(sText.IsEmpty());
  }
}

void ezQtFilePropertyWidget::on_TextFinished_triggered()
{
  ezStringBuilder sText = m_pWidget->text().toUtf8().data();

  UpdateRequiredIndicator(sText.IsEmpty());

  BroadcastValueChanged(sText.GetData());
}

void ezQtFilePropertyWidget::on_TextChanged_triggered(const QString& value)
{
  if (!hasFocus())
    on_TextFinished_triggered();
}

void ezQtFilePropertyWidget::OnOpenExplorer()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  ezQtUiServices::OpenInExplorer(sPath, true);
}


void ezQtFilePropertyWidget::OnCustomAction()
{
  auto pAttr = m_pProp->GetAttributeByType<ezFileBrowserAttribute>();

  if (pAttr->GetCustomAction() == nullptr)
    return;

  auto it = ezDocumentManager::s_CustomActions.Find(pAttr->GetCustomAction());

  if (!it.IsValid())
    return;

  ezVariant res = it.Value()(m_pGrid->GetDocument());

  if (!res.IsValid() || !res.IsA<ezString>())
    return;

  m_pWidget->setText(res.Get<ezString>().GetData());
  on_TextFinished_triggered();
}

void ezQtFilePropertyWidget::OnOpenFile()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  if (ezQtUiServices::OpenFileInDefaultProgram(sPath).Failed())
  {
    ezQtUiServices::MessageBoxInformation(ezFmt("File could not be opened:\n{0}\nCheck that the file exists, that a program is associated "
                                                "with this file type and that access to this file is not denied.",
      sPath));
  }
}

void ezQtFilePropertyWidget::OnOpenFileWith()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  ezQtUiServices::OpenWith(sPath);
}

void ezQtFilePropertyWidget::OnCreateFile()
{
  const ezFileBrowserAttribute* pFileAttribute = m_pProp->GetAttributeByType<ezFileBrowserAttribute>();

  ezStringBuilder sStartDir = m_pGrid->GetDocument()->GetDocumentPath();
  sStartDir.RemoveFileExtension();

  const QString sTitle = QString("Create %1").arg(ezMakeQString(pFileAttribute->GetCreateTitle()));
  const QString sExt = QString("%1 %2").arg(ezMakeQString(pFileAttribute->GetCreateTitle())).arg(ezMakeQString(pFileAttribute->GetTypeFilter()));

  QString sResult = QFileDialog::getSaveFileName(this, sTitle, sStartDir.GetData(), sExt, nullptr);

  if (sResult.isEmpty())
    return;


  ezStringBuilder sPath = sResult.toUtf8().data();

  if (!ezOSFile::ExistsFile(sPath))
  {
    ezStringBuilder sTemplateDoc = "Editor/DocumentTemplates/Default";
    sTemplateDoc.ChangeFileExtension(sPath.GetFileExtension());

    bool bCreate = true;

    ezStringBuilder sAbs;
    if (ezFileSystem::ResolvePath(sTemplateDoc, &sAbs, nullptr).Succeeded())
    {
      if (ezOSFile::CopyFile(sAbs, sPath).Succeeded())
      {
        bCreate = false;
      }
    }

    if (bCreate)
    {
      ezOSFile file;
      file.Open(sPath, ezFileOpenMode::Write).IgnoreResult();
    }
  }

  if (!ezQtEditorApp::GetSingleton()->MakePathDataDirectoryRelative(sPath))
    return;

  m_pWidget->setText(ezMakeQString(sPath));
  on_TextFinished_triggered();
}

static ezMap<ezString, ezString> s_StartDirs;

void ezQtFilePropertyWidget::on_BrowseFile_clicked()
{
  ezString sFile = m_pWidget->text().toUtf8().data();
  const ezFileBrowserAttribute* pFileAttribute = m_pProp->GetAttributeByType<ezFileBrowserAttribute>();

  auto& sStartDir = s_StartDirs[pFileAttribute->GetTypeFilter()];

  if (!sFile.IsEmpty())
  {
    ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sFile);

    ezStringBuilder st = sFile;
    st = st.GetFileDirectory();

    sStartDir = st;
  }

  if (sStartDir.IsEmpty())
    sStartDir = ezToolsProject::GetSingleton()->GetProjectFile();

  ezQtAssetBrowserDlg dlg(this, pFileAttribute->GetDialogTitle(), sFile, pFileAttribute->GetTypeFilter());
  if (dlg.exec() == QDialog::Rejected)
    return;

  ezStringView sResult = dlg.GetSelectedAssetPathRelative();

  if (sResult.IsEmpty())
    return;

  // the returned path is a "datadir parent relative path" and we must remove the first folder
  if (const char* nextSep = sResult.FindSubString("/"))
  {
    sResult.SetStartPosition(nextSep + 1);
  }

  sStartDir = sResult;

  m_pWidget->setText(ezMakeQString(sResult));
  on_TextFinished_triggered();
}

//////////////////////////////////////////////////////////////////////////

ezQtExternalFilePropertyWidget::ezQtExternalFilePropertyWidget()
  : ezQtStandardPropertyWidget()
{
  m_pLayout = new QHBoxLayout(this);
  m_pLayout->setContentsMargins(0, 0, 0, 0);
  setLayout(m_pLayout);

  m_pWidget = new QLineEdit(this);
  m_pWidget->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Preferred);
  m_pWidget->setFocusPolicy(Qt::FocusPolicy::StrongFocus);
  setFocusProxy(m_pWidget);

  EZ_VERIFY(connect(m_pWidget, SIGNAL(editingFinished()), this, SLOT(on_TextFinished_triggered())) != nullptr, "signal/slot connection failed");
  EZ_VERIFY(connect(m_pWidget, SIGNAL(textChanged(const QString&)), this, SLOT(on_TextChanged_triggered(const QString&))) != nullptr, "signal/slot connection failed");

  m_pButton = new QToolButton(this);
  m_pButton->setText(QStringLiteral("... "));
  m_pButton->setToolButtonStyle(Qt::ToolButtonStyle::ToolButtonTextOnly);
  m_pButton->setPopupMode(QToolButton::ToolButtonPopupMode::InstantPopup);
  m_pButton->setContextMenuPolicy(Qt::ContextMenuPolicy::NoContextMenu);

  {
    QMenu* pMenu = new QMenu();

    pMenu->setDefaultAction(pMenu->addAction(QIcon(), QLatin1String("Select File"), this, SLOT(on_BrowseFile_clicked())));
    QAction* pActionOpenFile = pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/Document.svg")), QLatin1String("Open File"), this, SLOT(OnOpenFile()));
    QAction* pActionOpenWith = pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/Document.svg")), QLatin1String("Open With..."), this, SLOT(OnOpenFileWith()));
    pMenu->addAction(QIcon(QLatin1String(":/GuiFoundation/Icons/OpenFolder.svg")), QLatin1String("Open in Explorer"), this, SLOT(OnOpenExplorer()));

    connect(pMenu, &QMenu::aboutToShow, pMenu, [=]()
      {
        pActionOpenFile->setEnabled(!m_pWidget->text().isEmpty());
        pActionOpenWith->setEnabled(!m_pWidget->text().isEmpty());
        //
      });
    m_pButton->setMenu(pMenu);
  }

  m_pLayout->addWidget(m_pWidget);
  m_pLayout->addWidget(m_pButton);
}

bool ezQtExternalFilePropertyWidget::IsValidFileReference(ezStringView sFile) const
{
  auto pAttr = m_pProp->GetAttributeByType<ezExternalFileBrowserAttribute>();

  ezTempHybridArray<ezStringView, 8> extensions;
  ezStringView sTemp = pAttr->GetTypeFilter();
  sTemp.Split(false, extensions, ";");
  for (ezStringView& ext : extensions)
  {
    ext.TrimWordStart("*.");
    if (sFile.GetFileExtension().IsEqual_NoCase(ext))
      return true;
  }

  return false;
}

void ezQtExternalFilePropertyWidget::OnInit()
{
  auto pAttr = m_pProp->GetAttributeByType<ezExternalFileBrowserAttribute>();
  EZ_ASSERT_DEV(pAttr != nullptr, "ezQtFilePropertyWidget was created without a ezExternalFileBrowserAttribute!");
}

void ezQtExternalFilePropertyWidget::InternalSetValue(const ezVariant& value)
{
  ezQtScopedBlockSignals b(m_pWidget);
  ezQtScopedBlockSignals b2(m_pButton);

  if (!value.IsValid())
  {
    m_pWidget->setPlaceholderText(QStringLiteral("<Multiple Values>"));
  }
  else
  {
    ezStringBuilder sText = value.ConvertTo<ezString>();

    m_pWidget->setPlaceholderText(QString());
    m_pWidget->setText(QString::fromUtf8(sText.GetData()));
  }
}

void ezQtExternalFilePropertyWidget::on_TextFinished_triggered()
{
  ezStringBuilder sText = m_pWidget->text().toUtf8().data();

  BroadcastValueChanged(sText.GetData());
}

void ezQtExternalFilePropertyWidget::on_TextChanged_triggered(const QString& value)
{
  if (!hasFocus())
    on_TextFinished_triggered();
}

void ezQtExternalFilePropertyWidget::OnOpenExplorer()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  ezQtUiServices::OpenInExplorer(sPath, true);
}

void ezQtExternalFilePropertyWidget::OnOpenFile()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  if (ezQtUiServices::OpenFileInDefaultProgram(sPath).Failed())
  {
    ezQtUiServices::MessageBoxInformation(ezFmt("File could not be opened:\n{0}\nCheck that the file exists, that a program is associated "
                                                "with this file type and that access to this file is not denied.",
      sPath));
  }
}

void ezQtExternalFilePropertyWidget::OnOpenFileWith()
{
  ezString sPath = m_pWidget->text().toUtf8().data();
  if (!ezQtEditorApp::GetSingleton()->MakeDataDirectoryRelativePathAbsolute(sPath))
    return;

  ezQtUiServices::OpenWith(sPath);
}

void ezQtExternalFilePropertyWidget::on_BrowseFile_clicked()
{
  ezString sFile = m_pWidget->text().toUtf8().data();
  const ezExternalFileBrowserAttribute* pFileAttribute = m_pProp->GetAttributeByType<ezExternalFileBrowserAttribute>();

  auto& sStartDir = s_StartDirs[pFileAttribute->GetTypeFilter()];

  if (sStartDir.IsEmpty())
  {
    sStartDir = sFile.GetFileDirectory();
  }

  if (sStartDir.IsEmpty())
  {
    sStartDir = ezToolsProject::GetSingleton()->GetProjectFile();
  }

  QString sResult = QFileDialog::getOpenFileName(this, ezMakeQString(pFileAttribute->GetDialogTitle()), sStartDir.GetData(), ezMakeQString(pFileAttribute->GetTypeFilter()), nullptr, QFileDialog::Option::DontResolveSymlinks);

  if (sResult.isEmpty())
    return;

  sFile = sResult.toUtf8().data();

  // doesn't matter if this fails
  ezQtEditorApp::GetSingleton()->MakePathDataDirectoryRelative(sFile);

  sStartDir = sFile.GetFileDirectory();

  m_pWidget->setText(sResult);
  on_TextFinished_triggered();
}