Isis 3 Developer Reference: Isis::GuiStringParameter Class Reference

Isis 3 Developer Reference

#include <GuiStringParameter.h>

Inheritance diagram for Isis::GuiStringParameter:

Inheritance graph

Collaboration diagram for Isis::GuiStringParameter:

Collaboration graph

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

Signals
void	ValueChanged ()

void	HelperTrigger (const QString &)

Public Member Functions
	GuiStringParameter (QGridLayout *grid, UserInterface &ui, int group, int param)

	~GuiStringParameter ()

QString	Value ()

void	Set (QString newValue)

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

virtual std::vector< QString >	Exclusions ()
	Return list of current exclusions. More...

ParameterType	Type ()

Protected Attributes
QToolButton *	p_fileButton

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

◆ GuiStringParameter()

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

References Isis::GuiParameter::AddHelpers(), IsisAml::HelpersSize(), Isis::GuiParameter::p_type, Isis::GuiParameter::p_ui, Isis::GuiParameter::RememberWidget(), Isis::GuiParameter::StringWidget, and Isis::GuiParameter::ValueChanged().

◆ ~GuiStringParameter()

Isis::GuiStringParameter::~GuiStringParameter ( )

Member Function Documentation

◆ AddHelpers()

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

inherited

Sets up helper button.

References _FILEINFO_, 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 GuiStringParameter().

◆ Exclusions()

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

virtualinherited

Return list of current exclusions.

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

◆ 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(), Isis::GuiComboBoxParameter::GuiComboBoxParameter(), Isis::GuiDoubleParameter::GuiDoubleParameter(), Isis::GuiFileNameParameter::GuiFileNameParameter(), Isis::GuiIntegerParameter::GuiIntegerParameter(), Isis::GuiListParameter::GuiListParameter(), and GuiStringParameter().

◆ Set()

void Isis::GuiStringParameter::Set ( QString newValue )

virtual

Implements Isis::GuiParameter.

◆ 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::GuiStringParameter::Value ( )

virtual

Implements Isis::GuiParameter.

◆ 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(), GuiStringParameter(), Isis::GuiBooleanParameter::Set(), Isis::GuiListParameter::Set(), and Isis::GuiComboBoxParameter::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(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiListParameter::Exclusions(), Isis::GuiParameter::GuiParameter(), Isis::GuiBooleanParameter::IsModified(), Isis::GuiParameter::IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), Isis::GuiParameter::SetToDefault(), Isis::GuiParameter::Update(), Isis::GuiComboBoxParameter::Value(), and Isis::GuiListParameter::Value().

◆ p_label

QLabel* Isis::GuiParameter::p_label

protectedinherited

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

◆ 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(), Isis::GuiComboBoxParameter::Exclusions(), Isis::GuiListParameter::Exclusions(), Isis::GuiParameter::GuiParameter(), Isis::GuiBooleanParameter::IsModified(), Isis::GuiParameter::IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiComboBoxParameter::Set(), Isis::GuiListParameter::Set(), Isis::GuiParameter::SetToDefault(), Isis::GuiParameter::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(), GuiStringParameter(), Isis::GuiParameter::SetEnabled(), and Isis::GuiParameter::Type().

◆ p_ui

UserInterface* Isis::GuiParameter::p_ui

protectedinherited

Referenced by Isis::GuiParameter::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(), Isis::GuiParameter::GuiParameter(), GuiStringParameter(), Isis::GuiBooleanParameter::IsModified(), Isis::GuiParameter::IsModified(), Isis::GuiFileNameParameter::SelectFile(), Isis::GuiBooleanParameter::Set(), Isis::GuiListParameter::Set(), Isis::GuiComboBoxParameter::Set(), Isis::GuiParameter::SetToCurrent(), Isis::GuiParameter::SetToDefault(), Isis::GuiParameter::Update(), Isis::GuiListParameter::Value(), and Isis::GuiComboBoxParameter::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:

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Gui/GuiStringParameter.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Gui/GuiStringParameter.cpp