Show templates as separate project explorer tab. (#8902)

Add templates as separate project explorer tab.
Add support for renaming and editing templates

ApplicationLibCode/Application/CMakeLists_files.cmake

@@ -73,7 +73,6 @@ set(QT_MOC_HEADERS
     ${CMAKE_CURRENT_LIST_DIR}/RiaConsoleApplication.h
     ${CMAKE_CURRENT_LIST_DIR}/RiaGuiApplication.h
     ${CMAKE_CURRENT_LIST_DIR}/RiaCompletionTypeCalculationScheduler.h
-    ${CMAKE_CURRENT_LIST_DIR}/RiaViewRedrawScheduler.h
     ${CMAKE_CURRENT_LIST_DIR}/RiaPlotWindowRedrawScheduler.h
     ${CMAKE_CURRENT_LIST_DIR}/RiaScheduler.h
 )

ApplicationLibCode/Commands/PlotBuilderCommands/RicAppendSummaryCurvesForSummaryAddressesFeature.cpp

@@ -66,9 +66,7 @@ void RicAppendSummaryCurvesForSummaryAddressesFeature::onActionTriggered( bool i
 //--------------------------------------------------------------------------------------------------
 void RicAppendSummaryCurvesForSummaryAddressesFeature::setupActionLook( QAction* actionToSetup )
 {
-    QString objectType = "Addresses";
-
-    auto text = QString( "Append Curves For " ) + objectType;
+    auto text = QString( "Append Curves For Vector" );
     actionToSetup->setText( text );
     actionToSetup->setIcon( QIcon( ":/SummaryCurve16x16.png" ) );
 }

ApplicationLibCode/Commands/PlotBuilderCommands/RicAppendSummaryPlotsForSummaryAddressesFeature.cpp

@@ -82,9 +82,7 @@ void RicAppendSummaryPlotsForSummaryAddressesFeature::onActionTriggered( bool is
 //--------------------------------------------------------------------------------------------------
 void RicAppendSummaryPlotsForSummaryAddressesFeature::setupActionLook( QAction* actionToSetup )
 {
-    QString objectType = "Addresses";
-
-    auto text = QString( "Append Plots For " ) + objectType;
+    auto text = QString( "Append Plots For Vector" );
     actionToSetup->setText( text );
     actionToSetup->setIcon( QIcon( ":/SummaryPlotLight16x16.png" ) );
 }

ApplicationLibCode/Commands/PlotTemplateCommands/CMakeLists_files.cmake

@@ -6,6 +6,8 @@ set(SOURCE_GROUP_HEADER_FILES
     ${CMAKE_CURRENT_LIST_DIR}/RicSaveMultiPlotTemplateFeature.h
     ${CMAKE_CURRENT_LIST_DIR}/RicSaveMultiPlotTemplateFeatureSettings.h
     ${CMAKE_CURRENT_LIST_DIR}/RicCreateMultiPlotFromSelectionFeature.h
+    ${CMAKE_CURRENT_LIST_DIR}/RicRenamePlotTemplateFeature.h
+    ${CMAKE_CURRENT_LIST_DIR}/RicEditPlotTemplateFeature.h
 )
 
 set(SOURCE_GROUP_SOURCE_FILES
@@ -16,6 +18,8 @@ set(SOURCE_GROUP_SOURCE_FILES
     ${CMAKE_CURRENT_LIST_DIR}/RicSaveMultiPlotTemplateFeature.cpp
     ${CMAKE_CURRENT_LIST_DIR}/RicSaveMultiPlotTemplateFeatureSettings.cpp
     ${CMAKE_CURRENT_LIST_DIR}/RicCreateMultiPlotFromSelectionFeature.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/RicRenamePlotTemplateFeature.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/RicEditPlotTemplateFeature.cpp
 )
 
 list(APPEND COMMAND_CODE_HEADER_FILES ${SOURCE_GROUP_HEADER_FILES})

ApplicationLibCode/Commands/PlotTemplateCommands/RicEditPlotTemplateFeature.cpp

@@ -0,0 +1,92 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2022     Equinor ASA
+//
+//  ResInsight is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.
+//
+//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
+//  for more details.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#include "RicEditPlotTemplateFeature.h"
+
+#include "RiaApplication.h"
+#include "RiaLogging.h"
+
+#include "PlotTemplates/RimPlotTemplateFileItem.h"
+#include "RimProject.h"
+
+#include "RiuPlotMainWindow.h"
+
+#include "cafSelectionManager.h"
+
+#include <QAction>
+#include <QFile>
+#include <QFileInfo>
+#include <QInputDialog>
+#include <QMessageBox>
+#include <QString>
+
+CAF_CMD_SOURCE_INIT( RicEditPlotTemplateFeature, "RicEditPlotTemplateFeature" );
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RicEditPlotTemplateFeature::isCommandEnabled()
+{
+    std::vector<caf::PdmUiItem*> uiItems;
+    caf::SelectionManager::instance()->selectedItems( uiItems );
+    if ( uiItems.size() != 1 ) return false;
+
+    RimPlotTemplateFileItem* file = dynamic_cast<RimPlotTemplateFileItem*>( uiItems[0] );
+    return ( file != nullptr );
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicEditPlotTemplateFeature::onActionTriggered( bool isChecked )
+{
+    std::vector<caf::PdmUiItem*> uiItems;
+    caf::SelectionManager::instance()->selectedItems( uiItems );
+
+    if ( uiItems.size() != 1 ) return;
+
+    RimPlotTemplateFileItem* file = dynamic_cast<RimPlotTemplateFileItem*>( uiItems[0] );
+    if ( file == nullptr ) return;
+
+    RiaApplication* app          = RiaApplication::instance();
+    QString         scriptEditor = app->scriptEditorPath();
+    if ( !scriptEditor.isEmpty() )
+    {
+        QStringList arguments;
+        arguments << file->absoluteFilePath();
+
+        QProcess* myProcess = new QProcess( this );
+        myProcess->start( scriptEditor, arguments );
+
+        if ( !myProcess->waitForStarted( 1000 ) )
+        {
+            RiaLogging::errorInMessageBox( RiuPlotMainWindow::instance(),
+                                           "Text editor",
+                                           "Failed to start text editor executable\n" + scriptEditor );
+        }
+    }
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicEditPlotTemplateFeature::setupActionLook( QAction* actionToSetup )
+{
+    actionToSetup->setText( "Edit" );
+    actionToSetup->setIcon( QIcon( ":/SummaryTemplate16x16.png" ) );
+}

ApplicationLibCode/Commands/PlotTemplateCommands/RicEditPlotTemplateFeature.h

@@ -0,0 +1,34 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2022     Equinor ASA
+//
+//  ResInsight is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.
+//
+//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
+//  for more details.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "cafCmdFeature.h"
+
+//==================================================================================================
+///
+//==================================================================================================
+class RicEditPlotTemplateFeature : public caf::CmdFeature
+{
+    CAF_CMD_HEADER_INIT;
+
+protected:
+    bool isCommandEnabled() override;
+    void onActionTriggered( bool isChecked ) override;
+    void setupActionLook( QAction* actionToSetup ) override;
+};

ApplicationLibCode/Commands/PlotTemplateCommands/RicReloadPlotTemplatesFeature.h

@@ -20,8 +20,6 @@
 
 #include "cafCmdFeature.h"
 
-class RimSummaryPlot;
-
 //==================================================================================================
 ///
 //==================================================================================================

ApplicationLibCode/Commands/PlotTemplateCommands/RicRenamePlotTemplateFeature.cpp

@@ -0,0 +1,99 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2022     Equinor ASA
+//
+//  ResInsight is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.
+//
+//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
+//  for more details.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#include "RicRenamePlotTemplateFeature.h"
+
+#include "PlotTemplates/RimPlotTemplateFileItem.h"
+
+#include "RiuPlotMainWindow.h"
+
+#include "cafSelectionManager.h"
+
+#include <QAction>
+#include <QFile>
+#include <QFileInfo>
+#include <QInputDialog>
+#include <QMessageBox>
+#include <QString>
+
+CAF_CMD_SOURCE_INIT( RicRenamePlotTemplateFeature, "RicRenamePlotTemplateFeature" );
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RicRenamePlotTemplateFeature::isCommandEnabled()
+{
+    std::vector<caf::PdmUiItem*> uiItems;
+    caf::SelectionManager::instance()->selectedItems( uiItems );
+    if ( uiItems.size() != 1 ) return false;
+
+    RimPlotTemplateFileItem* file = dynamic_cast<RimPlotTemplateFileItem*>( uiItems[0] );
+    return ( file != nullptr );
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicRenamePlotTemplateFeature::onActionTriggered( bool isChecked )
+{
+    std::vector<caf::PdmUiItem*> uiItems;
+    caf::SelectionManager::instance()->selectedItems( uiItems );
+
+    if ( uiItems.size() != 1 ) return;
+
+    RimPlotTemplateFileItem* file = dynamic_cast<RimPlotTemplateFileItem*>( uiItems[0] );
+    if ( file == nullptr ) return;
+
+    QFileInfo fi( file->absoluteFilePath() );
+
+    QWidget* parent = RiuPlotMainWindow::instance();
+
+    bool    ok;
+    QString newname =
+        QInputDialog::getText( parent, "Rename Plot Template", "Enter new name:", QLineEdit::Normal, fi.baseName(), &ok );
+
+    if ( !ok ) return;
+
+    newname = newname.trimmed();
+
+    if ( newname.isEmpty() || newname.contains( "/" ) || newname.contains( "\\" ) )
+    {
+        QMessageBox::critical( parent, "Rename failed", "Invalid name given.", QMessageBox::Ok );
+        return;
+    }
+
+    QString newPath = fi.absolutePath() + "/" + newname + "." + fi.completeSuffix();
+
+    if ( !QFile::rename( file->absoluteFilePath(), newPath ) )
+    {
+        QMessageBox::critical( parent, "Rename failed", "Unable to rename the selected plot template.", QMessageBox::Ok );
+        return;
+    }
+
+    file->setFilePath( newPath );
+    file->updateConnectedEditors();
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicRenamePlotTemplateFeature::setupActionLook( QAction* actionToSetup )
+{
+    actionToSetup->setText( "Rename" );
+    actionToSetup->setIcon( QIcon( ":/SummaryTemplate16x16.png" ) );
+}

ApplicationLibCode/Commands/PlotTemplateCommands/RicRenamePlotTemplateFeature.h

@@ -0,0 +1,34 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2022     Equinor ASA
+//
+//  ResInsight is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.
+//
+//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
+//  for more details.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "cafCmdFeature.h"
+
+//==================================================================================================
+///
+//==================================================================================================
+class RicRenamePlotTemplateFeature : public caf::CmdFeature
+{
+    CAF_CMD_HEADER_INIT;
+
+protected:
+    bool isCommandEnabled() override;
+    void onActionTriggered( bool isChecked ) override;
+    void setupActionLook( QAction* actionToSetup ) override;
+};

ApplicationLibCode/ProjectDataModel/PlotTemplates/RimPlotTemplateFolderItem.cpp

@@ -35,7 +35,7 @@ CAF_PDM_SOURCE_INIT( RimPlotTemplateFolderItem, "PlotTemplateCollection" );
 //--------------------------------------------------------------------------------------------------
 RimPlotTemplateFolderItem::RimPlotTemplateFolderItem()
 {
-    CAF_PDM_InitObject( "PlotTemplateCollection", ":/Folder.png" );
+    CAF_PDM_InitObject( "Plot Templates", ":/Folder.png" );
 
     CAF_PDM_InitFieldNoDefault( &m_folderName, "FolderName", "Folder" );
     CAF_PDM_InitFieldNoDefault( &m_fileNames, "FileNames", "" );

ApplicationLibCode/ProjectDataModel/RimContextCommandBuilder.cpp

@@ -1022,6 +1022,8 @@ caf::CmdFeatureMenuBuilder RimContextCommandBuilder::commandsFromSelection()
         else if ( dynamic_cast<RimPlotTemplateFolderItem*>( firstUiItem ) ||
                   dynamic_cast<RimPlotTemplateFileItem*>( firstUiItem ) )
         {
+            menuBuilder << "RicRenamePlotTemplateFeature";
+            menuBuilder << "RicEditPlotTemplateFeature";
             menuBuilder << "RicReloadPlotTemplatesFeature";
         }
         else if ( dynamic_cast<RimSummaryMultiPlot*>( firstUiItem ) )

ApplicationLibCode/ProjectDataModel/RimProject.cpp

@@ -214,9 +214,9 @@ RimProject::RimProject( void )
 
     mainPlotCollection = new RimMainPlotCollection();
 
-    CAF_PDM_InitFieldNoDefault( &m_plotTemplateFolderItem, "PlotTemplateCollection", "Plot Templates" );
-    m_plotTemplateFolderItem = new RimPlotTemplateFolderItem();
-    m_plotTemplateFolderItem.xmlCapability()->disableIO();
+    CAF_PDM_InitFieldNoDefault( &m_plotTemplateTopFolder, "PlotTemplateCollection", "Plot Templates" );
+    m_plotTemplateTopFolder = new RimPlotTemplateFolderItem();
+    m_plotTemplateTopFolder.xmlCapability()->disableIO();
 
     // For now, create a default first oilfield that contains the rest of the project
     oilFields.push_back( new RimOilField );
@@ -403,12 +403,12 @@ void RimProject::setScriptDirectories( const QString& scriptDirectories )
 //--------------------------------------------------------------------------------------------------
 void RimProject::setPlotTemplateFolders( const QStringList& plotTemplateFolders )
 {
-    if ( !m_plotTemplateFolderItem() )
+    if ( !m_plotTemplateTopFolder() )
     {
-        m_plotTemplateFolderItem = new RimPlotTemplateFolderItem();
+        m_plotTemplateTopFolder = new RimPlotTemplateFolderItem();
     }
 
-    m_plotTemplateFolderItem->createRootFolderItemsFromFolderPaths( plotTemplateFolders );
+    m_plotTemplateTopFolder->createRootFolderItemsFromFolderPaths( plotTemplateFolders );
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -1322,7 +1322,7 @@ RimMeasurement* RimProject::measurement() const
 //--------------------------------------------------------------------------------------------------
 RimPlotTemplateFolderItem* RimProject::rootPlotTemlateItem() const
 {
-    return m_plotTemplateFolderItem;
+    return m_plotTemplateTopFolder;
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -1461,6 +1461,10 @@ void RimProject::defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, Q
     {
         uiTreeOrdering.add( scriptCollection() );
     }
+    else if ( uiConfigName == "PlotWindow.Templates" )
+    {
+        uiTreeOrdering.add( m_plotTemplateTopFolder );
+    }
     else if ( uiConfigName == "MainWindow.DataSources" )
     {
         RimOilField* oilField = activeOilField();

ApplicationLibCode/ProjectDataModel/RimProject.h

@@ -212,7 +212,7 @@ private:
     caf::PdmField<QString> m_projectFileVersionString;
 
     caf::PdmChildField<RimDialogData*>             m_dialogData;
-    caf::PdmChildField<RimPlotTemplateFolderItem*> m_plotTemplateFolderItem;
+    caf::PdmChildField<RimPlotTemplateFolderItem*> m_plotTemplateTopFolder;
 
     caf::PdmField<bool> m_show3DWindow;
     caf::PdmField<bool> m_showPlotWindow;

ApplicationLibCode/UserInterface/RiuDockWidgetTools.cpp

@@ -148,6 +148,14 @@ QString RiuDockWidgetTools::plotMainWindowPlotsTreeName()
     return "plotMainWindow_dockPlotsTree";
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+QString RiuDockWidgetTools::plotMainWindowTemplateTreeName()
+{
+    return "plotMainWindow_dockTemplatesTree";
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------

ApplicationLibCode/UserInterface/RiuDockWidgetTools.h

@@ -54,6 +54,7 @@ public:
 
     static QString plotMainWindowDataSourceTreeName();
     static QString plotMainWindowPlotsTreeName();
+    static QString plotMainWindowTemplateTreeName();
     static QString plotMainWindowScriptsTreeName();
 
     static QString plotMainWindowPropertyEditorName();

ApplicationLibCode/UserInterface/RiuPlotMainWindow.cpp

@@ -121,6 +121,18 @@ QString RiuPlotMainWindow::mainWindowName()
     return "RiuPlotMainWindow";
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+RiuPlotMainWindow* RiuPlotMainWindow::instance()
+{
+    if ( RiaGuiApplication::isRunning() )
+    {
+        return RiaGuiApplication::instance()->mainPlotWindow();
+    }
+    return nullptr;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -460,11 +472,15 @@ void RiuPlotMainWindow::refreshToolbars()
 //--------------------------------------------------------------------------------------------------
 void RiuPlotMainWindow::createDockPanels()
 {
-    const int                  nTreeViews      = 3;
-    const std::vector<QString> treeViewTitles  = { "Plots", "Data Sources", "Scripts" };
-    const std::vector<QString> treeViewConfigs = { "PlotWindow.Plots", "PlotWindow.DataSources", "PlotWindow.Scripts" };
+    const int                  nTreeViews        = 4;
+    const std::vector<QString> treeViewTitles    = { "Plots", "Data Sources", "Templates", "Scripts" };
+    const std::vector<QString> treeViewConfigs   = { "PlotWindow.Plots",
+                                                   "PlotWindow.DataSources",
+                                                   "PlotWindow.Templates",
+                                                   "PlotWindow.Scripts" };
     const std::vector<QString> treeViewDockNames = { RiuDockWidgetTools::plotMainWindowPlotsTreeName(),
                                                      RiuDockWidgetTools::plotMainWindowDataSourceTreeName(),
+                                                     RiuDockWidgetTools::plotMainWindowTemplateTreeName(),
                                                      RiuDockWidgetTools::plotMainWindowScriptsTreeName() };
 
     createTreeViews( nTreeViews );

ApplicationLibCode/UserInterface/RiuPlotMainWindow.h

@@ -58,6 +58,8 @@ public:
     RiuPlotMainWindow();
     ~RiuPlotMainWindow() override;
 
+    static RiuPlotMainWindow* instance();
+
     QString mainWindowName() override;
 
     void initializeGuiNewProjectLoaded();