OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve the help for a calculation

Browse Source 
Add help text and plus AND example


Improve help pages for calculator
This commit is contained in:
Magne Sjaastad
2022-12-13 14:47:26 +01:00
parent bfae28b4b4
commit e4c0b45b15
6 changed files with 183 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
ApplicationLibCode/ProjectDataModel/RimUserDefinedCalculation.cpp
View File

@@ -21,13 +21,16 @@
#include "expressionparser/ExpressionParser.h"
#include "RiaLogging.h"
#include "RiaNetworkTools.h"
#include "RimProject.h"
#include "RimUserDefinedCalculationVariable.h"
#include "RiuExpressionContextMenuManager.h"
#include "cafPdmUiLabelEditor.h"
#include "cafPdmUiLineEditor.h"
#include "cafPdmUiPushButtonEditor.h"
#include "cafPdmUiTableViewEditor.h"
#include "cafPdmUiTextEditor.h"
@@ -45,9 +48,21 @@ RimUserDefinedCalculation::RimUserDefinedCalculation()
CAF_PDM_InitFieldNoDefault( &m_description, "Description", "Description" );
m_description.uiCapability()->setUiReadOnly( true );
CAF_PDM_InitField( &m_expression, "Expression", QString( "" ), "Expression" );
CAF_PDM_InitField( &m_expression, "Expression", QString( "" ), "" );
m_expression.uiCapability()->setUiEditorTypeName( caf::PdmUiTextEditor::uiEditorTypeName() );
CAF_PDM_InitFieldNoDefault( &m_helpButton, "HelpButton", "" );
caf::PdmUiPushButtonEditor::configureEditorForField( &m_helpButton );
m_helpButton.xmlCapability()->disableIO();
CAF_PDM_InitFieldNoDefault( &m_helpText,
"Label",
"Use the right-click menu inside the text area for quick access to operators and "
"functions." );
m_helpText.uiCapability()->setUiEditorTypeName( caf::PdmUiLabelEditor::uiEditorTypeName() );
m_helpText.xmlCapability()->disableIO();
m_helpText = "Use the right-click menu inside the text area for quick access to operators and functions.";
CAF_PDM_InitField( &m_unit, "Unit", QString( "" ), "Unit" );
m_unit.uiCapability()->setUiEditorTypeName( caf::PdmUiLineEditor::uiEditorTypeName() );
@@ -293,6 +308,16 @@ void RimUserDefinedCalculation::fieldChangedByUi( const caf::PdmFieldHandle* cha
const QVariant& oldValue,
const QVariant& newValue )
{
if ( changedField == &m_helpButton )
{
m_helpButton = false;
QString urlString = "https://resinsight.org/calculated-data/calculatorexpressions/";
RiaNetworkTools::openUrl( urlString );
return;
}
m_isDirty = true;
PdmObject::fieldChangedByUi( changedField, oldValue, newValue );
@@ -303,8 +328,10 @@ void RimUserDefinedCalculation::fieldChangedByUi( const caf::PdmFieldHandle* cha
//--------------------------------------------------------------------------------------------------
void RimUserDefinedCalculation::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
uiOrdering.add( &m_helpButton );
uiOrdering.add( &m_description );
uiOrdering.add( &m_expression );
uiOrdering.add( &m_helpText );
uiOrdering.add( &m_unit );
}
@@ -377,6 +404,14 @@ void RimUserDefinedCalculation::defineEditorAttribute( const caf::PdmFieldHandle
myAttr->enableDropTarget = true;
}
}
else if ( field == &m_helpButton )
{
auto* attrib = dynamic_cast<caf::PdmUiPushButtonEditorAttribute*>( attribute );
if ( attrib )
{
attrib->m_buttonText = "Open Help Page";
}
}
}
//--------------------------------------------------------------------------------------------------

2
ApplicationLibCode/ProjectDataModel/RimUserDefinedCalculation.h
View File

@@ -86,6 +86,8 @@ protected:
protected:
caf::PdmField<QString> m_description;
caf::PdmField<QString> m_expression;
caf::PdmField<bool> m_helpButton;
caf::PdmField<QString> m_helpText;
caf::PdmField<QString> m_unit;
caf::PdmChildArrayField<RimUserDefinedCalculationVariable*> m_variables;