Isis::GuiParameter Class Reference

#include <GuiParameter.h>

Inherits QObject.

Inherited by Isis::GuiBooleanParameter, Isis::GuiComboBoxParameter, Isis::GuiDoubleParameter, Isis::GuiFileNameParameter, Isis::GuiIntegerParameter, Isis::GuiListParameter, and Isis::GuiStringParameter.

List of all members.

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.
QWidget *	AddHelpers (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
UserInterface *	p_ui
QLabel *	p_label
QList< QWidget * >	p_widgetList
ParameterType	p_type

---

Detailed Description

Author:

2006-10-31 ???

---

Member Enumeration Documentation

enum Isis::GuiParameter::ParameterType

Enumerator:

IntegerWidget
DoubleWidget
StringWidget
ListWidget
FileNameWidget
CubeWidget
BooleanWidget
ComboWidget

---

Constructor & Destructor Documentation

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

Isis::GuiParameter::~GuiParameter

(

)

[virtual]

Destructor.

References p_widgetList.

---

Member Function Documentation

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

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

(

)

[virtual]

Return list of current exclusions.

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

void Isis::GuiParameter::HelperTrigger

(

const QString &

)

[signal]

Referenced by AddHelpers().

bool Isis::GuiParameter::IsEnabled

(

)

const [inline]

Is the parameter enabled.

References p_label.

Referenced by IsModified(), and Isis::GuiBooleanParameter::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().

QString Isis::GuiParameter::Name

(

)

const [inline]

Return the name of the parameter.

References p_name.

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

virtual void Isis::GuiParameter::Set

(

QString

newValue

)

[pure virtual]

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

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

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

Enable or disable the parameter.

References ComboWidget, p_label, p_type, and p_widgetList.

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

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

ParameterType Isis::GuiParameter::Type

(

)

[inline]

References p_type.

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

virtual QString Isis::GuiParameter::Value

(

)

[pure virtual]

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

Referenced by IsModified().

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

---

Member Data Documentation

QToolButton* Isis::GuiParameter::p_fileButton [protected]

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

int Isis::GuiParameter::p_group [protected]

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

QLabel* Isis::GuiParameter::p_label [protected]

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

QLineEdit* Isis::GuiParameter::p_lineEdit [protected]

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

QString Isis::GuiParameter::p_name [protected]

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

int Isis::GuiParameter::p_param [protected]

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

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

UserInterface* Isis::GuiParameter::p_ui [protected]

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

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

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

---

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

• src/base/objs/Gui/GuiParameter.h
• src/base/objs/Gui/GuiParameter.cpp