File failed to load: https://isis.astrogeology.usgs.gov/dev/Object/assets/jax/output/NativeMML/config.js
Isis Developer Reference
Public Types | Signals | Public Member Functions | Protected Slots | Protected Attributes | List of all members
Isis::GuiCubeParameter Class Reference

#include <GuiCubeParameter.h>

Inheritance diagram for Isis::GuiCubeParameter:
Inheritance graph
Collaboration diagram for Isis::GuiCubeParameter:
Collaboration graph

Public Types

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

Signals

void ValueChanged ()
 
void HelperTrigger (const QString &)
 

Public Member Functions

 GuiCubeParameter (QGridLayout *grid, UserInterface &ui, int group, int param)
 Constructs GuiCubeParameter object.
 
 ~GuiCubeParameter ()
 Destructor of GuiCubeParameter object.
 
QString Value ()
 Gets the value found in the line edit text box.
 
void Set (QString newValue)
 Sets the line edit text box to value passed in by this method.
 
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.
 
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.
 
QWidget * AddHelpers (QObject *lo)
 Sets up helper button.
 
virtual std::vector< QString > Exclusions ()
 Return list of current exclusions.
 
ParameterType Type ()
 

Protected Slots

virtual void SelectFile ()
 Gets an input/output file from a GUI filechooser or typed in filename.
 

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
inherited
Enumerator
IntegerWidget 
DoubleWidget 
StringWidget 
ListWidget 
FileNameWidget 
CubeWidget 
BooleanWidget 
ComboWidget 

Constructor & Destructor Documentation

◆ GuiCubeParameter()

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

Constructs GuiCubeParameter object.

Parameters
gridPointer to QGridLayout
uiUser interface object
groupIndex of group
paramIndex of parameter

References Isis::GuiParameter::CubeWidget, Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiParameter::p_fileButton, Isis::GuiParameter::p_type, and Isis::GuiFileNameParameter::SelectFile().

◆ ~GuiCubeParameter()

Isis::GuiCubeParameter::~GuiCubeParameter ( )

Destructor of GuiCubeParameter object.

Member Function Documentation

◆ AddHelpers()

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

Sets up helper button.

References _FILEINFO_, Isis::FileName::expanded(), 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 ( )
virtualinherited

Return list of current exclusions.

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

◆ HelperTrigger

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

Referenced by AddHelpers().

◆ IsEnabled()

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

Is the parameter enabled.

References p_label.

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

◆ IsModified()

bool Isis::GuiParameter::IsModified ( )
virtualinherited

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

Reimplemented in Isis::GuiBooleanParameter.

References IsEnabled(), p_group, p_param, p_ui, and Value().

◆ Name()

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

Return the name of the parameter.

References p_name.

◆ RememberWidget()

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

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

◆ SelectFile

void Isis::GuiFileNameParameter::SelectFile ( )
protectedvirtualslotinherited

Gets an input/output file from a GUI filechooser or typed in filename.

This method determines which directory to look in, sets up extension filters, and gets the filename.

References Isis::FileName::dir(), Isis::FileName::expanded(), Isis::FileName::name(), Isis::GuiParameter::p_fileButton, Isis::GuiParameter::p_group, Isis::GuiParameter::p_lineEdit, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, and Set().

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

◆ Set()

void Isis::GuiFileNameParameter::Set ( QString newValue)
virtualinherited

Sets the line edit text box to value passed in by this method.

Parameters
newValue

Implements Isis::GuiParameter.

References Isis::GuiParameter::p_lineEdit.

Referenced by SelectFile().

◆ SetEnabled()

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

Enable or disable the parameter.

References ComboWidget, p_label, p_type, and p_widgetList.

◆ SetToCurrent()

void Isis::GuiParameter::SetToCurrent ( )
inherited

Change the parameter to the current user interface value.

References p_name, p_ui, Set(), and SetToDefault().

◆ SetToDefault()

void Isis::GuiParameter::SetToDefault ( )
inherited

Change the parameter to the default value.

References p_group, p_param, p_ui, and Set().

Referenced by SetToCurrent().

◆ Type()

ParameterType Isis::GuiParameter::Type ( )
inlineinherited

References p_type.

◆ Update()

void Isis::GuiParameter::Update ( )
inherited

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

References p_group, p_name, p_param, p_ui, and Set().

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

◆ Value()

QString Isis::GuiFileNameParameter::Value ( )
virtualinherited

Gets the value found in the line edit text box.

Returns
IString Value found in line edit text box

Implements Isis::GuiParameter.

References Isis::GuiParameter::p_lineEdit.

◆ ValueChanged

void Isis::GuiParameter::ValueChanged ( )
signalinherited

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::GuiComboBoxParameter::Set(), and Isis::GuiListParameter::Set().

Member Data Documentation

◆ p_fileButton

QToolButton* Isis::GuiParameter::p_fileButton
protectedinherited

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

◆ p_group

int Isis::GuiParameter::p_group
protectedinherited

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiListParameter::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
protectedinherited

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

◆ p_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit
protectedinherited

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

◆ p_name

QString Isis::GuiParameter::p_name
protectedinherited

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

◆ p_param

int Isis::GuiParameter::p_param
protectedinherited

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiListParameter::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
protectedinherited

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
protectedinherited

Referenced by AddHelpers(), Isis::GuiBooleanParameter::Exclusions(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiListParameter::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::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), SetToCurrent(), SetToDefault(), Update(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().

◆ p_widgetList

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

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

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