birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixing problems with document tab management

Browse Source 
Signed-off-by: Guthrie Adams <guthadam@amazon.com>
This commit is contained in:
Guthrie Adams
2021-08-05 22:36:43 -05:00
parent d6f08151cc
commit 1c181af94e
6 changed files with 106 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/Atom/Tools/AtomToolsFramework/Code/Include/AtomToolsFramework/Window/AtomToolsMainWindow.h
+5 -3
View File
@@ -39,11 +39,13 @@ namespace AtomToolsFramework
AZStd::vector<AZStd::string> GetDockWidgetNames() const override;
virtual void CreateMenu();
virtual void CreateTabBar();
virtual void AddTabForDocumentId(const AZ::Uuid& documentId);
virtual void AddTabForDocumentId(
const AZ::Uuid& documentId, const AZStd::string& label, const AZStd::string& toolTip, AZStd::function<QWidget*()> widgetCreator);
virtual void RemoveTabForDocumentId(const AZ::Uuid& documentId);
virtual void UpdateTabForDocumentId(const AZ::Uuid& documentId);
virtual void UpdateTabForDocumentId(
const AZ::Uuid& documentId, const AZStd::string& label, const AZStd::string& toolTip, bool isModified);
virtual AZ::Uuid GetDocumentIdFromTab(const int tabIndex) const;
virtual void OpenTabContextMenu();
Gems/Atom/Tools/AtomToolsFramework/Code/Source/Window/AtomToolsMainWindow.cpp
+29 -3
View File
@@ -133,7 +133,8 @@ namespace AtomToolsFramework
});
}
void AtomToolsMainWindow::AddTabForDocumentId(const AZ::Uuid& documentId)
void AtomToolsMainWindow::AddTabForDocumentId(
const AZ::Uuid& documentId, const AZStd::string& label, const AZStd::string& toolTip, AZStd::function<QWidget*()> widgetCreator)
{
// Blocking signals from the tab bar so the currentChanged signal is not sent while a document is already being opened.
// This prevents the OnDocumentOpened notification from being sent recursively.
@@ -149,6 +150,16 @@ namespace AtomToolsFramework
return;
}
}
const int tabIndex = m_tabWidget->addTab(widgetCreator(), label.c_str());
// The user can manually reorder tabs which will invalidate any association by index.
// We need to store the document ID with the tab using the tab instead of a separate mapping.
m_tabWidget->tabBar()->setTabData(tabIndex, QVariant(documentId.ToString<QString>()));
m_tabWidget->setTabToolTip(tabIndex, toolTip.c_str());
m_tabWidget->setCurrentIndex(tabIndex);
m_tabWidget->setVisible(true);
m_tabWidget->repaint();
}
void AtomToolsMainWindow::RemoveTabForDocumentId(const AZ::Uuid& documentId)
@@ -167,12 +178,27 @@ namespace AtomToolsFramework
}
}
void AtomToolsMainWindow::UpdateTabForDocumentId(const AZ::Uuid& documentId)
void AtomToolsMainWindow::UpdateTabForDocumentId(
const AZ::Uuid& documentId, const AZStd::string& label, const AZStd::string& toolTip, bool isModified)
{
// Whenever a document is opened, saved, or modified we need to update the tab label
if (!documentId.IsNull())
{
return;
// Because tab order and indexes can change from user interactions, we cannot store a map
// between a tab index and document ID.
// We must iterate over all of the tabs to find the one associated with this document.
for (int tabIndex = 0; tabIndex < m_tabWidget->count(); ++tabIndex)
{
if (documentId == GetDocumentIdFromTab(tabIndex))
{
// We use an asterisk appended to the file name to denote modified document
const AZStd::string modifiedLabel = isModified ? label + " *" : label;
m_tabWidget->setTabText(tabIndex, modifiedLabel.c_str());
m_tabWidget->setTabToolTip(tabIndex, toolTip.c_str());
m_tabWidget->repaint();
break;
}
}
}
}
Gems/Atom/Tools/MaterialEditor/Code/Source/Window/MaterialEditorWindow.cpp
+33 -80
View File
@@ -183,14 +183,31 @@ namespace MaterialEditor
MaterialDocumentRequestBus::EventResult(isOpen, documentId, &MaterialDocumentRequestBus::Events::IsOpen);
bool isSavable = false;
MaterialDocumentRequestBus::EventResult(isSavable, documentId, &MaterialDocumentRequestBus::Events::IsSavable);
bool isModified = false;
MaterialDocumentRequestBus::EventResult(isModified, documentId, &MaterialDocumentRequestBus::Events::IsModified);
bool canUndo = false;
MaterialDocumentRequestBus::EventResult(canUndo, documentId, &MaterialDocumentRequestBus::Events::CanUndo);
bool canRedo = false;
MaterialDocumentRequestBus::EventResult(canRedo, documentId, &MaterialDocumentRequestBus::Events::CanRedo);
AZStd::string absolutePath;
MaterialDocumentRequestBus::EventResult(absolutePath, documentId, &MaterialDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
// Update UI to display the new document
AddTabForDocumentId(documentId);
UpdateTabForDocumentId(documentId);
if (!documentId.IsNull() && isOpen)
{
// Create a new tab for the document ID and assign it's label to the file name of the document.
AddTabForDocumentId(documentId, filename, absolutePath, [this]{
// The tab widget requires a dummy page per tab
auto contentWidget = new QWidget(m_centralWidget);
contentWidget->setContentsMargins(0, 0, 0, 0);
contentWidget->setFixedSize(0, 0);
return contentWidget;
});
}
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
const bool hasTabs = m_tabWidget->count() > 0;
@@ -246,7 +263,13 @@ namespace MaterialEditor
void MaterialEditorWindow::OnDocumentModified(const AZ::Uuid& documentId)
{
UpdateTabForDocumentId(documentId);
bool isModified = false;
MaterialDocumentRequestBus::EventResult(isModified, documentId, &MaterialDocumentRequestBus::Events::IsModified);
AZStd::string absolutePath;
MaterialDocumentRequestBus::EventResult(absolutePath, documentId, &MaterialDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
}
void MaterialEditorWindow::OnDocumentUndoStateChanged(const AZ::Uuid& documentId)
@@ -264,7 +287,13 @@ namespace MaterialEditor
void MaterialEditorWindow::OnDocumentSaved(const AZ::Uuid& documentId)
{
UpdateTabForDocumentId(documentId);
bool isModified = false;
MaterialDocumentRequestBus::EventResult(isModified, documentId, &MaterialDocumentRequestBus::Events::IsModified);
AZStd::string absolutePath;
MaterialDocumentRequestBus::EventResult(absolutePath, documentId, &MaterialDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
const QString documentPath = GetDocumentPath(documentId);
const QString status = QString("Material closed: %1").arg(documentPath);
@@ -490,82 +519,6 @@ namespace MaterialEditor
});
}
void MaterialEditorWindow::AddTabForDocumentId(const AZ::Uuid& documentId)
{
bool isOpen = false;
MaterialDocumentRequestBus::EventResult(isOpen, documentId, &MaterialDocumentRequestBus::Events::IsOpen);
if (documentId.IsNull() || !isOpen)
{
return;
}
AtomToolsMainWindow::AddTabForDocumentId(documentId);
// Blocking signals from the tab bar so the currentChanged signal is not sent while a document is already being opened.
// This prevents the OnDocumentOpened notification from being sent recursively.
const QSignalBlocker blocker(m_tabWidget);
// Create a new tab for the document ID and assign it's label to the file name of the document.
AZStd::string absolutePath;
MaterialDocumentRequestBus::EventResult(absolutePath, documentId, &MaterialDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
// The tab widget requires a dummy page per tab
QWidget* placeHolderWidget = new QWidget(m_centralWidget);
placeHolderWidget->setContentsMargins(0, 0, 0, 0);
placeHolderWidget->resize(0, 0);
placeHolderWidget->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
const int tabIndex = m_tabWidget->addTab(placeHolderWidget, filename.c_str());
// The user can manually reorder tabs which will invalidate any association by index.
// We need to store the document ID with the tab using the tab instead of a separate mapping.
m_tabWidget->tabBar()->setTabData(tabIndex, QVariant(documentId.ToString<QString>()));
m_tabWidget->setTabToolTip(tabIndex, absolutePath.c_str());
m_tabWidget->setCurrentIndex(tabIndex);
m_tabWidget->setVisible(true);
m_tabWidget->repaint();
}
void MaterialEditorWindow::UpdateTabForDocumentId(const AZ::Uuid& documentId)
{
// Whenever a document is opened, saved, or modified we need to update the tab label
if (!documentId.IsNull())
{
// Because tab order and indexes can change from user interactions, we cannot store a map
// between a tab index and document ID.
// We must iterate over all of the tabs to find the one associated with this document.
for (int tabIndex = 0; tabIndex < m_tabWidget->count(); ++tabIndex)
{
if (documentId == GetDocumentIdFromTab(tabIndex))
{
AZStd::string absolutePath;
MaterialDocumentRequestBus::EventResult(absolutePath, documentId, &MaterialDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
bool isModified = false;
MaterialDocumentRequestBus::EventResult(isModified, documentId, &MaterialDocumentRequestBus::Events::IsModified);
// We use an asterisk appended to the file name to denote modified document
if (isModified)
{
filename += " *";
}
m_tabWidget->setTabText(tabIndex, filename.c_str());
m_tabWidget->setTabToolTip(tabIndex, absolutePath.c_str());
m_tabWidget->repaint();
break;
}
}
}
}
QString MaterialEditorWindow::GetDocumentPath(const AZ::Uuid& documentId) const
{
AZStd::string absolutePath;
Gems/Atom/Tools/MaterialEditor/Code/Source/Window/MaterialEditorWindow.h
-2
View File
@@ -56,8 +56,6 @@ namespace MaterialEditor
void CreateMenu() override;
void CreateTabBar() override;
void AddTabForDocumentId(const AZ::Uuid& documentId) override;
void UpdateTabForDocumentId(const AZ::Uuid& documentId) override;
QString GetDocumentPath(const AZ::Uuid& documentId) const;
void OpenTabContextMenu() override;
Gems/Atom/Tools/ShaderManagementConsole/Code/Source/Window/ShaderManagementConsoleWindow.cpp
+38 -85
View File
@@ -86,14 +86,32 @@ namespace ShaderManagementConsole
ShaderManagementConsoleDocumentRequestBus::EventResult(isOpen, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsOpen);
bool isSavable = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isSavable, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsSavable);
bool isModified = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isModified, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsModified);
bool canUndo = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(canUndo, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::CanUndo);
bool canRedo = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(canRedo, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::CanRedo);
AZStd::string absolutePath;
ShaderManagementConsoleDocumentRequestBus::EventResult(absolutePath, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
// Update UI to display the new document
AddTabForDocumentId(documentId);
UpdateTabForDocumentId(documentId);
if (!documentId.IsNull() && isOpen)
{
// Create a new tab for the document ID and assign it's label to the file name of the document.
AddTabForDocumentId(documentId, filename, absolutePath, [this, documentId]{
// The document tab contains a table view.
auto contentWidget = new QTableView(m_centralWidget);
contentWidget->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
contentWidget->setSelectionBehavior(QAbstractItemView::SelectRows);
contentWidget->setModel(CreateDocumentContent(documentId));
return contentWidget;
});
}
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
const bool hasTabs = m_tabWidget->count() > 0;
@@ -133,7 +151,13 @@ namespace ShaderManagementConsole
void ShaderManagementConsoleWindow::OnDocumentModified(const AZ::Uuid& documentId)
{
UpdateTabForDocumentId(documentId);
bool isModified = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isModified, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsModified);
AZStd::string absolutePath;
ShaderManagementConsoleDocumentRequestBus::EventResult(absolutePath, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
}
void ShaderManagementConsoleWindow::OnDocumentUndoStateChanged(const AZ::Uuid& documentId)
@@ -151,7 +175,13 @@ namespace ShaderManagementConsole
void ShaderManagementConsoleWindow::OnDocumentSaved(const AZ::Uuid& documentId)
{
UpdateTabForDocumentId(documentId);
bool isModified = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isModified, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsModified);
AZStd::string absolutePath;
ShaderManagementConsoleDocumentRequestBus::EventResult(absolutePath, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
UpdateTabForDocumentId(documentId, filename, absolutePath, isModified);
}
void ShaderManagementConsoleWindow::CreateMenu()
@@ -291,86 +321,6 @@ namespace ShaderManagementConsole
});
}
void ShaderManagementConsoleWindow::AddTabForDocumentId(const AZ::Uuid& documentId)
{
bool isOpen = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isOpen, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsOpen);
if (documentId.IsNull() || !isOpen)
{
return;
}
AtomToolsMainWindow::AddTabForDocumentId(documentId);
// Blocking signals from the tab bar so the currentChanged signal is not sent while a document is already being opened.
// This prevents the OnDocumentOpened notification from being sent recursively.
const QSignalBlocker blocker(m_tabWidget);
// Create a new tab for the document ID and assign it's label to the file name of the document.
AZStd::string absolutePath;
ShaderManagementConsoleDocumentRequestBus::EventResult(absolutePath, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
// The document tab contains a table view.
auto tableView = new QTableView(m_centralWidget);
tableView->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
tableView->setSelectionBehavior(QAbstractItemView::SelectRows);
auto model = new QStandardItemModel();
tableView->setModel(model);
const int tabIndex = m_tabWidget->addTab(tableView, filename.c_str());
// The user can manually reorder tabs which will invalidate any association by index.
// We need to store the document ID with the tab using the tab instead of a separate mapping.
m_tabWidget->tabBar()->setTabData(tabIndex, QVariant(documentId.ToString<QString>()));
m_tabWidget->setTabToolTip(tabIndex, absolutePath.c_str());
m_tabWidget->setCurrentIndex(tabIndex);
m_tabWidget->setVisible(true);
m_tabWidget->repaint();
CreateDocumentContent(documentId, model);
}
void ShaderManagementConsoleWindow::UpdateTabForDocumentId(const AZ::Uuid& documentId)
{
// Whenever a document is opened, saved, or modified we need to update the tab label
if (!documentId.IsNull())
{
// Because tab order and indexes can change from user interactions, we cannot store a map
// between a tab index and document ID.
// We must iterate over all of the tabs to find the one associated with this document.
for (int tabIndex = 0; tabIndex < m_tabWidget->count(); ++tabIndex)
{
if (documentId == GetDocumentIdFromTab(tabIndex))
{
AZStd::string absolutePath;
ShaderManagementConsoleDocumentRequestBus::EventResult(absolutePath, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetAbsolutePath);
AZStd::string filename;
AzFramework::StringFunc::Path::GetFullFileName(absolutePath.c_str(), filename);
bool isModified = false;
ShaderManagementConsoleDocumentRequestBus::EventResult(isModified, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::IsModified);
// We use an asterisk appended to the file name to denote modified document
if (isModified)
{
filename += " *";
}
m_tabWidget->setTabText(tabIndex, filename.c_str());
m_tabWidget->setTabToolTip(tabIndex, absolutePath.c_str());
m_tabWidget->repaint();
break;
}
}
}
}
void ShaderManagementConsoleWindow::OpenTabContextMenu()
{
const QTabBar* tabBar = m_tabWidget->tabBar();
@@ -427,7 +377,7 @@ namespace ShaderManagementConsole
}
}
void ShaderManagementConsoleWindow::CreateDocumentContent(const AZ::Uuid& documentId, QStandardItemModel* model)
QStandardItemModel* ShaderManagementConsoleWindow::CreateDocumentContent(const AZ::Uuid& documentId)
{
AZStd::unordered_set<AZStd::string> optionNames;
@@ -446,6 +396,7 @@ namespace ShaderManagementConsole
size_t shaderVariantCount = 0;
ShaderManagementConsoleDocumentRequestBus::EventResult(shaderVariantCount, documentId, &ShaderManagementConsoleDocumentRequestBus::Events::GetShaderVariantCount);
auto model = new QStandardItemModel();
model->setRowCount(static_cast<int>(shaderVariantCount));
model->setColumnCount(static_cast<int>(optionNames.size()));
@@ -474,6 +425,8 @@ namespace ShaderManagementConsole
model->setItem(variantIndex, optionIndex, item);
}
}
return model;
}
} // namespace ShaderManagementConsole
Gems/Atom/Tools/ShaderManagementConsole/Code/Source/Window/ShaderManagementConsoleWindow.h
+1 -5
View File
@@ -52,10 +52,6 @@ namespace ShaderManagementConsole
void CreateMenu() override;
void CreateTabBar() override;
void AddTabForDocumentId(const AZ::Uuid& documentId) override;
void UpdateTabForDocumentId(const AZ::Uuid& documentId) override;
void OpenTabContextMenu() override;
void SelectDocumentForTab(const int tabIndex);
@@ -64,7 +60,7 @@ namespace ShaderManagementConsole
void closeEvent(QCloseEvent* closeEvent) override;
void CreateDocumentContent(const AZ::Uuid& documentId, QStandardItemModel* model);
QStandardItemModel* CreateDocumentContent(const AZ::Uuid& documentId);
ShaderManagementConsoleToolBar* m_toolBar = nullptr;