Isis 3 Developer Reference
Public Types | Signals | Public Member Functions | Protected Attributes | List of all members
Isis::GuiParameter Class Referenceabstract

#include <GuiParameter.h>

Inheritance diagram for Isis::GuiParameter:
Inheritance graph
Collaboration diagram for Isis::GuiParameter:
Collaboration graph

Public Types

enum  ParameterType {
  IntegerWidget, DoubleWidget, StringWidget, ListWidget,
  FileNameWidget, CubeWidget, BooleanWidget, ComboWidget
}
 

Signals

void ValueChanged ()
 
void HelperTrigger (const QString &)
 

Public Member Functions

 GuiParameter (QGridLayout *grid, UserInterface &ui, int group, int param)
 Constructor. More...
 
virtual ~GuiParameter ()
 Destructor. More...
 
QString Name () const
 Return the name of the parameter. More...
 
void SetToDefault ()
 Change the parameter to the default value. More...
 
void SetToCurrent ()
 Change the parameter to the current user interface value. More...
 
virtual QString Value ()=0
 
virtual void Set (QString newValue)=0
 
void SetEnabled (bool enabled, bool isParentCombo=false)
 Enable or disable the parameter. More...
 
bool IsEnabled () const
 Is the parameter enabled. More...
 
virtual bool IsModified ()
 Return if the parameter value is different from the default value. More...
 
void Update ()
 Update the value on the GUI with the value in the UI. More...
 
void RememberWidget (QWidget *w)
 Add widgets to a list for enabling/disabling. More...
 
QWidget * AddHelpers (QObject *lo)
 Sets up helper button. More...
 
virtual std::vector< QString > Exclusions ()
 Return list of current exclusions. More...
 
ParameterType Type ()
 

Protected Attributes

QToolButton * p_fileButton
 
QLineEdit * p_lineEdit
 
int p_group
 
int p_param
 
QString p_name
 
UserInterface * p_ui
 
QLabel * p_label
 
QList< QWidget * > p_widgetList
 
ParameterType p_type
 

Detailed Description

Author
2006-10-31 ???

Member Enumeration Documentation

◆ ParameterType

enum Isis::GuiParameter::ParameterType
Enumerator
IntegerWidget 
DoubleWidget 
StringWidget 
ListWidget 
FileNameWidget 
CubeWidget 
BooleanWidget 
ComboWidget 

Constructor & Destructor Documentation

◆ GuiParameter()

Isis::GuiParameter::GuiParameter ( QGridLayout *  grid,
UserInterface &  ui,
int  group,
int  param 
)

Constructor.

References p_fileButton, p_group, p_label, p_lineEdit, p_name, p_param, p_ui, IsisAml::ParamBrief(), IsisAml::ParamDefault(), IsisAml::ParamExclude(), IsisAml::ParamExcludeSize(), IsisAml::ParamGreaterThan(), IsisAml::ParamGreaterThanOrEqual(), IsisAml::ParamGreaterThanOrEqualSize(), IsisAml::ParamGreaterThanSize(), IsisAml::ParamInclude(), IsisAml::ParamIncludeSize(), IsisAml::ParamInternalDefault(), IsisAml::ParamLessThan(), IsisAml::ParamLessThanOrEqual(), IsisAml::ParamLessThanOrEqualSize(), IsisAml::ParamLessThanSize(), IsisAml::ParamMaximum(), IsisAml::ParamMaximumInclusive(), IsisAml::ParamMinimum(), IsisAml::ParamMinimumInclusive(), IsisAml::ParamName(), IsisAml::ParamNotEqual(), IsisAml::ParamNotEqualSize(), IsisAml::ParamOdd(), IsisAml::ParamType(), and IsisAml::PixelType().

◆ ~GuiParameter()

Isis::GuiParameter::~GuiParameter ( )
virtual

Destructor.

References p_widgetList.

Member Function Documentation

◆ AddHelpers()

QWidget * Isis::GuiParameter::AddHelpers ( QObject *  lo)

Sets up helper button.

References _FILEINFO_, IsisAml::HelperBrief(), IsisAml::HelperButtonName(), IsisAml::HelperDescription(), IsisAml::HelperFunction(), IsisAml::HelperIcon(), IsisAml::HelpersSize(), HelperTrigger(), p_group, p_param, p_ui, Isis::IException::Programmer, and RememberWidget().

Referenced by Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiStringParameter::GuiStringParameter().

◆ Exclusions()

std::vector< QString > Isis::GuiParameter::Exclusions ( )
virtual

Return list of current exclusions.

Reimplemented in Isis::GuiComboBoxParameter, Isis::GuiListParameter, and Isis::GuiBooleanParameter.

◆ HelperTrigger

void Isis::GuiParameter::HelperTrigger ( const QString &  )
signal

Referenced by AddHelpers().

◆ IsEnabled()

bool Isis::GuiParameter::IsEnabled ( ) const
inline

Is the parameter enabled.

References p_label.

Referenced by Isis::GuiBooleanParameter::IsModified(), and IsModified().

◆ IsModified()

bool Isis::GuiParameter::IsModified ( )
virtual

Return if the parameter value is different from the default value.

Reimplemented in Isis::GuiBooleanParameter.

References IsEnabled(), p_group, p_param, p_ui, IsisAml::ParamDefault(), IsisAml::ParamInternalDefault(), and Value().

◆ Name()

QString Isis::GuiParameter::Name ( ) const
inline

Return the name of the parameter.

References p_name.

◆ RememberWidget()

void Isis::GuiParameter::RememberWidget ( QWidget *  w)

Add widgets to a list for enabling/disabling.

References p_widgetList.

Referenced by AddHelpers(), Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiComboBoxParameter::GuiComboBoxParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), and Isis::GuiStringParameter::GuiStringParameter().

◆ Set()

virtual void Isis::GuiParameter::Set ( QString  newValue)
pure virtual

Implemented in Isis::GuiFileNameParameter, Isis::GuiComboBoxParameter, Isis::GuiListParameter, Isis::GuiIntegerParameter, Isis::GuiDoubleParameter, Isis::GuiStringParameter, and Isis::GuiBooleanParameter.

Referenced by SetToCurrent(), SetToDefault(), and Update().

◆ SetEnabled()

void Isis::GuiParameter::SetEnabled ( bool  enabled,
bool  isParentCombo = false 
)

Enable or disable the parameter.

References ComboWidget, p_label, p_type, and p_widgetList.

◆ SetToCurrent()

void Isis::GuiParameter::SetToCurrent ( )

Change the parameter to the current user interface value.

References IsisAml::GetAsString(), p_name, p_ui, Set(), SetToDefault(), and IsisAml::WasEntered().

◆ SetToDefault()

void Isis::GuiParameter::SetToDefault ( )

Change the parameter to the default value.

References p_group, p_param, p_ui, IsisAml::ParamDefault(), IsisAml::ParamInternalDefault(), and Set().

Referenced by SetToCurrent().

◆ Type()

ParameterType Isis::GuiParameter::Type ( )
inline

References p_type.

◆ Update()

void Isis::GuiParameter::Update ( )

Update the value on the GUI with the value in the UI.

References IsisAml::GetAsString(), p_group, p_name, p_param, p_ui, IsisAml::ParamDefault(), IsisAml::ParamInternalDefault(), Set(), and IsisAml::WasEntered().

Referenced by Isis::Gui::Gui().

◆ Value()

virtual QString Isis::GuiParameter::Value ( )
pure virtual

Implemented in Isis::GuiFileNameParameter, Isis::GuiComboBoxParameter, Isis::GuiListParameter, Isis::GuiIntegerParameter, Isis::GuiDoubleParameter, Isis::GuiStringParameter, and Isis::GuiBooleanParameter.

Referenced by IsModified().

◆ ValueChanged

void Isis::GuiParameter::ValueChanged ( )
signal

Referenced by Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiComboBoxParameter::GuiComboBoxParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), Isis::GuiStringParameter::GuiStringParameter(), Isis::GuiBooleanParameter::Set(), Isis::GuiListParameter::Set(), and Isis::GuiComboBoxParameter::Set().

Member Data Documentation

◆ p_fileButton

QToolButton* Isis::GuiParameter::p_fileButton
protected

Referenced by Isis::GuiCubeParameter::GuiCubeParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), GuiParameter(), and Isis::GuiFileNameParameter::SelectFile().

◆ p_group

int Isis::GuiParameter::p_group
protected

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiListParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), GuiParameter(), Isis::GuiBooleanParameter::IsModified(), IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), SetToDefault(), Update(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().

◆ p_label

QLabel* Isis::GuiParameter::p_label
protected

Referenced by Isis::GuiComboBoxParameter::GuiComboBoxParameter(), Isis::GuiListParameter::GuiListParameter(), GuiParameter(), IsEnabled(), and SetEnabled().

◆ p_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit
protected

Referenced by Isis::GuiFileNameParameter::GuiFileNameParameter(), GuiParameter(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiFileNameParameter::Set(), and Isis::GuiFileNameParameter::Value().

◆ p_name

QString Isis::GuiParameter::p_name
protected

Referenced by GuiParameter(), Name(), SetToCurrent(), and Update().

◆ p_param

int Isis::GuiParameter::p_param
protected

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiListParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), GuiParameter(), Isis::GuiBooleanParameter::IsModified(), IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), SetToDefault(), Update(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().

◆ p_type

ParameterType Isis::GuiParameter::p_type
protected

Referenced by Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiComboBoxParameter::GuiComboBoxParameter(), Isis::GuiCubeParameter::GuiCubeParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), Isis::GuiStringParameter::GuiStringParameter(), SetEnabled(), and Type().

◆ p_ui

UserInterface* Isis::GuiParameter::p_ui
protected

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiListParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiBooleanParameter::GuiBooleanParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), GuiParameter(), Isis::GuiStringParameter::GuiStringParameter(), Isis::GuiBooleanParameter::IsModified(), IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiBooleanParameter::Set(), Isis::GuiListParameter::Set(), Isis::GuiComboBoxParameter::Set(), SetToCurrent(), SetToDefault(), Update(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().

◆ p_widgetList

QList<QWidget *> Isis::GuiParameter::p_widgetList
protected

Referenced by RememberWidget(), SetEnabled(), and ~GuiParameter().

The documentation for this class was generated from the following files: