Isis Developer Reference
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.
 
virtual ~GuiParameter ()
 Destructor.
 
QString Name () const
 Return the name of the parameter.
 
void SetToDefault ()
 Change the parameter to the default value.
 
void SetToCurrent ()
 Change the parameter to the current user interface value.
 
virtual QString Value ()=0
 
virtual void Set (QString newValue)=0
 
void SetEnabled (bool enabled, bool isParentCombo=false)
 Enable or disable the parameter.
 
bool IsEnabled () const
 Is the parameter enabled.
 
virtual bool IsModified ()
 Return if the parameter value is different from the default value.
 
void Update ()
 Update the value on the GUI with the value in the UI.
 
void RememberWidget (QWidget *w)
 Add widgets to a list for enabling/disabling.
 
QWidgetAddHelpers (QObject *lo)
 Sets up helper button.
 
virtual std::vector< QString > Exclusions ()
 Return list of current exclusions.
 
ParameterType Type ()
 

Protected Attributes

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

Detailed Description

Author
2006-10-31 ???

Member Enumeration Documentation

◆ ParameterType

Enumerator
IntegerWidget 
DoubleWidget 
StringWidget 
ListWidget 
FileNameWidget 
CubeWidget 
BooleanWidget 
ComboWidget 

Constructor & Destructor Documentation

◆ GuiParameter()

◆ ~GuiParameter()

Isis::GuiParameter::~GuiParameter ( )
virtual

Destructor.

References p_widgetList.

Member Function Documentation

◆ AddHelpers()

◆ Exclusions()

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

Return list of current exclusions.

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

◆ 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()

◆ Set()

◆ 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().

◆ Value()

◆ ValueChanged

Member Data Documentation

◆ p_fileButton

◆ p_group

◆ p_label

◆ p_lineEdit

◆ p_name

QString Isis::GuiParameter::p_name
protected

◆ p_param

◆ p_type

◆ p_ui

◆ p_widgetList

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

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