GuiParameter.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <QFileDialog>
#include <QHBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QToolButton>
 
#include "GuiParameter.h"
 
#include "Application.h"
#include "FileName.h"
#include "GuiHelperAction.h"
#include "UserInterface.h"
 
#include "GuiFilenameParameter.h"
#include "GuiCubeParameter.h"
 
namespace Isis {
  GuiParameter::GuiParameter(QGridLayout *grid, UserInterface &ui,
                             int group, int param) : QObject() {
    p_ui = &ui;
    p_group = group;
    p_param = param;
 
    p_name = ui.ParamName(group, param);
    p_fileButton = new QToolButton();
    p_lineEdit = new QLineEdit();
 
    p_label = new QLabel(p_name);
    p_label->setAlignment(Qt::AlignRight | Qt::AlignVCenter);
    p_label->setToolTip(p_ui->ParamBrief(group, param));
    grid->addWidget(p_label, param, 0, Qt::AlignTop);
 
    QString whatsThis;
    whatsThis  = (QString)("<b>Parameter:</b> " + p_ui->ParamName(group, param));
    whatsThis += (QString)("<p><b>Type:</b> " + p_ui->ParamType(group, param) + "</p>");
    whatsThis += (QString)("<p><b>Brief:</b> " + p_ui->ParamBrief(group, param) + "</p>");
    QString def = p_ui->ParamDefault(group, param);
    if(def == "") def = "None";
    whatsThis += "<p><b>Default: </b>" + QString(def) + "</p>";
    QString intdef = p_ui->ParamInternalDefault(group, param);
    if(intdef != "") {
      whatsThis += "<p><b>Internal Default: </b> " + QString(intdef) + "</p>";
    }
    QString pixtype = p_ui->PixelType(group, param);
    if(pixtype != "") {
      whatsThis += "<p><b>Pixel Type: </b> " + QString(pixtype) + "</p>";
    }
    QString pmin = p_ui->ParamMinimum(group, param);
    if(pmin != "") {
      if(p_ui->ParamMinimumInclusive(group, param) == "YES") {
        whatsThis += "<p><b>Greater Than Or Equal To: </b>" +
                     QString(pmin) + "</p>";
      }
      else {
        whatsThis += "<p><b>Greater Than: </b>" + QString(pmin) + "</p>";
      }
    }
    QString pmax = p_ui->ParamMaximum(group, param);
    if(pmax != "") {
      if(p_ui->ParamMaximumInclusive(group, param) == "YES") {
        whatsThis += "<p><b>Less Than Or Equal To: </b>" +
                     QString(pmax) + "</p>";
      }
      else {
        whatsThis += "<p><b>Less Than: </b>" + QString(pmax) + "</p>";
      }
    }
    if(p_ui->ParamLessThanSize(group, param) > 0) {
      whatsThis += "<p><b>Less Than: </b>" +
                   QString(p_ui->ParamLessThan(group, param, 0));
      for(int l = 1; l < p_ui->ParamLessThanSize(group, param); l++) {
        whatsThis += ", " + QString(p_ui->ParamLessThan(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamLessThanOrEqualSize(group, param) > 0) {
      whatsThis += "<p><b>Less Than Or Equal: </b>" +
                   QString(p_ui->ParamLessThanOrEqual(group, param, 0));
      for(int l = 1; l < p_ui->ParamLessThanOrEqualSize(group, param); l++) {
        whatsThis += ", " +
                     QString(p_ui->ParamLessThanOrEqual(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamNotEqualSize(group, param) > 0) {
      whatsThis += "<p><b>Not Equal: </b>" +
                   QString(p_ui->ParamNotEqual(group, param, 0));
      for(int l = 1; l < p_ui->ParamNotEqualSize(group, param); l++) {
        whatsThis += ", " + QString(p_ui->ParamNotEqual(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamGreaterThanSize(group, param) > 0) {
      whatsThis += "<p><b>Greater Than: </b>" +
                   QString(p_ui->ParamGreaterThan(group, param, 0));
      for(int l = 1; l < p_ui->ParamGreaterThanSize(group, param); l++) {
        whatsThis += ", " +
                     QString(p_ui->ParamGreaterThan(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamGreaterThanOrEqualSize(group, param) > 0) {
      whatsThis += "<p><b>Greater Than Or Equal: </b>" +
                   QString(p_ui->ParamGreaterThanOrEqual(group, param, 0));
      for(int l = 1; l < p_ui->ParamGreaterThanOrEqualSize(group, param); l++) {
        whatsThis += ", " +
                     QString(p_ui->ParamGreaterThanOrEqual(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamIncludeSize(group, param) > 0) {
      whatsThis += "<p><b>Inclusions: </b>" +
                   QString(p_ui->ParamInclude(group, param, 0));
      for(int l = 1; l < p_ui->ParamIncludeSize(group, param); l++) {
        whatsThis += ", " +
                     QString(p_ui->ParamInclude(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamExcludeSize(group, param) > 0) {
      whatsThis += "<p><b>Exclusions: </b>" +
                   QString(p_ui->ParamExclude(group, param, 0));
      for(int l = 1; l < p_ui->ParamExcludeSize(group, param); l++) {
        whatsThis += ", " +
                     QString(p_ui->ParamExclude(group, param, l));
      }
      whatsThis += "</p>";
    }
    if(p_ui->ParamOdd(group, param) != "") {
      whatsThis += "<p><b>Odd: </b>" +
                   QString(p_ui->ParamOdd(group, param)) + "</p>";
    }
    p_label->setWhatsThis(whatsThis);
 
    p_helperMenu = NULL;
  }
 
 
  GuiParameter::~GuiParameter() {
    if(p_helperMenu) {
      delete p_helperMenu;
      p_helperMenu = NULL;
    }
 
    p_widgetList.clear();
  }
 
  void GuiParameter::SetToDefault() {
    if(p_ui->ParamDefault(p_group, p_param).size() > 0) {
      Set(p_ui->ParamDefault(p_group, p_param));
    }
    else if(p_ui->ParamInternalDefault(p_group, p_param).size() > 0) {
      Set(p_ui->ParamInternalDefault(p_group, p_param));
    }
    else {
      Set("");
    }
  }
 
  void GuiParameter::SetToCurrent() {
    if(p_ui->WasEntered(p_name)) {
      Set(p_ui->GetAsString(p_name));
    }
    else {
      SetToDefault();
    }
  }
 
  bool GuiParameter::IsModified() {
    if(!IsEnabled()) return false;
    if(p_ui->ParamDefault(p_group, p_param).size() > 0) {
      if(Value() == p_ui->ParamDefault(p_group, p_param)) return false;
    }
    else if(p_ui->ParamInternalDefault(p_group, p_param).size() > 0) {
      if(Value() == p_ui->ParamInternalDefault(p_group, p_param)) return false;
    }
    else {
      if(Value() == "") return false;
    }
    return true;
  }
 
  void GuiParameter::Update() {
    if(p_ui->WasEntered(p_name)) {
      Set(p_ui->GetAsString(p_name));
    }
    else if(p_ui->ParamDefault(p_group, p_param).size() > 0) {
      Set(p_ui->ParamDefault(p_group, p_param));
    }
    else if(p_ui->ParamInternalDefault(p_group, p_param).size() > 0) {
      Set(p_ui->ParamInternalDefault(p_group, p_param));
    }
    else {
      Set("");
    }
  }
 
  void GuiParameter::RememberWidget(QWidget *w) {
    p_widgetList.push_back(w);
  }
 
  void GuiParameter::SetEnabled(bool enabled, bool isParentCombo) {
    if(p_type != ComboWidget) {
      p_label->setEnabled(enabled);
      p_label->setVisible(true);
      if(isParentCombo && !enabled) {
        p_label->setVisible(false);
      }
      for(int i = 0; i < p_widgetList.size(); i++) {
        p_widgetList[i]->setEnabled(enabled);
        p_widgetList[i]->setVisible(true);
        if(isParentCombo && !enabled) {
          p_widgetList[i]->setVisible(false);
        }
      }
    }
    else {
      p_label->setEnabled(enabled);
      p_widgetList[0]->setEnabled(enabled);
    }
  }
 
  std::vector<QString> GuiParameter::Exclusions() {
    std::vector<QString> list;
    return list;
  }
 
  QWidget *GuiParameter::AddHelpers(QObject *lo) {
    // Just make one single helper button
    if(p_ui->HelpersSize(p_group, p_param) == 1) {
      GuiHelperAction *action =
        new GuiHelperAction(lo, p_ui->HelperFunction(p_group, p_param, 0));
      if(p_ui->HelperIcon(p_group, p_param, 0) != "") {
        QString file = FileName(
                         p_ui->HelperIcon(p_group, p_param, 0)).expanded();
        action->setIcon(QIcon(QPixmap(file)));
      }
      else {
        action->setText(p_ui->HelperButtonName(p_group, p_param, 0));
      }
      action->setToolTip(p_ui->HelperBrief(p_group, p_param, 0));
      QString helperText = "<p><b>Function:</b> " +
                           QString(p_ui->HelperDescription(p_group, p_param, 0)) + "</p>";
      action->setWhatsThis(helperText);
      connect(action, SIGNAL(trigger(const QString &)), this,
              SIGNAL(HelperTrigger(const QString &)));
 
      QToolButton *helper = new QToolButton();
      helper->setText(p_ui->HelperButtonName(p_group, p_param, 0));
      helper->setDefaultAction(action);
 
      if(p_ui->HelperIcon(p_group, p_param, 0) != "") {
        helper->setText("");
        QString file = FileName(
                         p_ui->HelperIcon(p_group, p_param, 0)).expanded();
        helper->setIconSize(QSize(22, 22));
        helper->setIcon(QIcon(QPixmap(file)));
      }
      else {
        helper->setFixedWidth(helper->fontMetrics().horizontalAdvance(
                                " " + helper->text() + " "));
      }
      RememberWidget(helper);
      return helper;
    }
 
    // Make a drop down menu of helper buttons
    else {
      if(p_helperMenu) {
        throw IException(IException::Programmer,
                         "Can not call GuiParameter::AddHelpers twice",
                         _FILEINFO_);
      }
 
      p_helperMenu = new QMenu();
 
      // Create default action item
      GuiHelperAction *action =
        new GuiHelperAction(lo, p_ui->HelperFunction(p_group, p_param, 0));
      if(p_ui->HelperIcon(p_group, p_param, 0) != "") {
        QString file = FileName(
                         p_ui->HelperIcon(p_group, p_param, 0)).expanded();
        action->setIcon(QIcon(QPixmap(file)));
      }
      else {
        action->setText(p_ui->HelperButtonName(p_group, p_param, 0));
      }
      connect(action, SIGNAL(trigger(const QString &)), this,
              SIGNAL(HelperTrigger(const QString &)));
 
      // Set up helper button
      QToolButton *helper = new QToolButton();
      helper->setText(p_ui->HelperButtonName(p_group, p_param, 0));
 
      helper->setMenu(p_helperMenu);
      helper->setPopupMode(QToolButton::MenuButtonPopup);
      helper->setDefaultAction(action);
      helper->setToolTip(p_ui->HelperBrief(p_group, p_param, 0));
      QString text = "<p><b>Function:</b> " +
                     QString(p_ui->HelperDescription(p_group, p_param, 0)) + "</p>" +
                     "<p><b>Hint: </b> Click on the arrow to see more helper functions</p>";
      helper->setWhatsThis(text);
 
      if(p_ui->HelperIcon(p_group, p_param, 0) != "") {
        helper->setText("");
        QString file = FileName(
                         p_ui->HelperIcon(p_group, p_param, 0)).expanded();
        helper->setIconSize(QSize(22, 22));
        helper->setIcon(QIcon(QPixmap(file)));
      }
      else {
        helper->setFixedWidth(helper->fontMetrics().horizontalAdvance(
                                "  " + helper->text() + "  "));
      }
 
      // Set up default action item in menu list
      GuiHelperAction *action2 =
        new GuiHelperAction(lo, p_ui->HelperFunction(p_group, p_param, 0));
      action2->setText(p_ui->HelperBrief(p_group, p_param, 0));
      action2->setToolTip(p_ui->HelperBrief(p_group, p_param, 0));
      QString helperText = "<p><b>Function:</b> " +
                           QString(p_ui->HelperDescription(p_group, p_param, 0)) + "</p>";
      action2->setWhatsThis(helperText);
      connect(action2, SIGNAL(trigger(const QString &)), this,
              SIGNAL(HelperTrigger(const QString &)));
      p_helperMenu->addAction(action2);
 
 
      // Add each additional helper button to the menu list
      for(int i = 1; i < p_ui->HelpersSize(p_group, p_param); i++) {
        GuiHelperAction *helperAction =
          new GuiHelperAction(lo, p_ui->HelperFunction(p_group, p_param, i));
        helperAction->setText(p_ui->HelperBrief(p_group, p_param, i));
        helperAction->setToolTip(p_ui->HelperBrief(p_group, p_param, i));
        QString helperText = "<p><b>Function:</b> " +
                             QString(p_ui->HelperDescription(p_group, p_param, i)) + "</p>";
        helperAction->setWhatsThis(helperText);
        connect(helperAction, SIGNAL(trigger(const QString &)), this,
                SIGNAL(HelperTrigger(const QString &)));
        p_helperMenu->addAction(helperAction);
      }
      RememberWidget(helper);
      return helper;
    }
  }
}