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

#include <GuiComboBoxParameter.h>

Inheritance diagram for Isis::GuiComboBoxParameter:
Inheritance graph
Collaboration diagram for Isis::GuiComboBoxParameter:
Collaboration graph

Public Types

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

Signals

void ValueChanged ()
 
void HelperTrigger (const QString &)
 

Public Member Functions

 GuiComboBoxParameter (QGridLayout *grid, UserInterface &ui, int group, int param)
 
 ~GuiComboBoxParameter ()
 
QString Value ()
 
void Set (QString newValue)
 
virtual std::vector< QString > Exclusions ()
 Return list of current exclusions. 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...
 
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...
 
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
????-??-?? Unknown

Member Enumeration Documentation

◆ ParameterType

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

Constructor & Destructor Documentation

◆ GuiComboBoxParameter()

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

References Isis::GuiParameter::ComboWidget, Isis::GuiParameter::p_label, Isis::GuiParameter::p_type, IsisAml::ParamListBrief(), IsisAml::ParamListSize(), IsisAml::ParamListValue(), Isis::GuiParameter::RememberWidget(), and Isis::GuiParameter::ValueChanged().

◆ ~GuiComboBoxParameter()

Isis::GuiComboBoxParameter::~GuiComboBoxParameter ( )

Member Function Documentation

◆ AddHelpers()

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

Sets up helper button.

References _FILEINFO_, Isis::FileName::expanded(), IsisAml::HelperBrief(), IsisAml::HelperButtonName(), IsisAml::HelperDescription(), IsisAml::HelperFunction(), IsisAml::HelperIcon(), IsisAml::HelpersSize(), Isis::GuiParameter::HelperTrigger(), Isis::GuiParameter::p_group, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, Isis::IException::Programmer, and Isis::GuiParameter::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::GuiComboBoxParameter::Exclusions ( )
virtual

Return list of current exclusions.

Reimplemented from Isis::GuiParameter.

References Isis::GuiParameter::p_group, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, IsisAml::ParamListExclude(), and IsisAml::ParamListExcludeSize().

◆ HelperTrigger

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

Referenced by Isis::GuiParameter::AddHelpers().

◆ IsEnabled()

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

Is the parameter enabled.

References Isis::GuiParameter::p_label.

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

◆ IsModified()

bool Isis::GuiParameter::IsModified ( )
virtualinherited

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

Reimplemented in Isis::GuiBooleanParameter.

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

◆ Name()

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

Return the name of the parameter.

References Isis::GuiParameter::p_name.

◆ RememberWidget()

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

Add widgets to a list for enabling/disabling.

References Isis::GuiParameter::p_widgetList.

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

◆ Set()

void Isis::GuiComboBoxParameter::Set ( QString  newValue)
virtual

Implements Isis::GuiParameter.

References Isis::GuiParameter::p_group, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, IsisAml::ParamListSize(), IsisAml::ParamListValue(), Isis::IString::UpCase(), and Isis::GuiParameter::ValueChanged().

◆ SetEnabled()

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

Enable or disable the parameter.

References Isis::GuiParameter::ComboWidget, Isis::GuiParameter::p_label, Isis::GuiParameter::p_type, and Isis::GuiParameter::p_widgetList.

◆ SetToCurrent()

void Isis::GuiParameter::SetToCurrent ( )
inherited

Change the parameter to the current user interface value.

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

◆ SetToDefault()

void Isis::GuiParameter::SetToDefault ( )
inherited

Change the parameter to the default value.

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

Referenced by Isis::GuiParameter::SetToCurrent().

◆ Type()

ParameterType Isis::GuiParameter::Type ( )
inlineinherited

References Isis::GuiParameter::p_type.

◆ Update()

void Isis::GuiParameter::Update ( )
inherited

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

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

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

◆ Value()

QString Isis::GuiComboBoxParameter::Value ( )
virtual

Implements Isis::GuiParameter.

References Isis::GuiParameter::p_group, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, and IsisAml::ParamListValue().

◆ ValueChanged

void Isis::GuiParameter::ValueChanged ( )
signalinherited

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

Member Data Documentation

◆ p_fileButton

QToolButton* Isis::GuiParameter::p_fileButton
protectedinherited

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

◆ p_group

int Isis::GuiParameter::p_group
protectedinherited

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

◆ p_label

QLabel* Isis::GuiParameter::p_label
protectedinherited

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

◆ p_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit
protectedinherited

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

◆ p_name

QString Isis::GuiParameter::p_name
protectedinherited

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

◆ p_param

int Isis::GuiParameter::p_param
protectedinherited

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

◆ p_type

ParameterType Isis::GuiParameter::p_type
protectedinherited

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

◆ p_ui

UserInterface* Isis::GuiParameter::p_ui
protectedinherited

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

◆ p_widgetList

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

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

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