Isis::GuiParameter Class Reference

#include <GuiParameter.h>

Inheritance diagram for Isis::GuiParameter:

Collaboration diagram for Isis::GuiParameter:

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

Private Attributes
QMenu *	p_helperMenu

Detailed Description

Author

2006-10-31 ???

History

2009-11-10 Mackenzie Boyd - Refactored to reduce code duplication in children GuiCubeParameter and GuiFileNameParameter, specifically, SelectFile method.

2009-12-15 Travis Addair - Moved the SelectFile method back to children.

Definition at line 34 of file GuiParameter.h.

Member Enumeration Documentation

ParameterType

enum Isis::GuiParameter::ParameterType

Definition at line 73 of file GuiParameter.h.

Constructor & Destructor Documentation

GuiParameter()

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

Constructor.

Definition at line 26 of file GuiParameter.cpp.

References IsisAml::ParamName().

Referenced by Isis::GuiFileNameParameter::GuiFileNameParameter().

~GuiParameter()

Isis::GuiParameter::~GuiParameter ( )

virtual

Destructor.

Definition at line 148 of file GuiParameter.cpp.

Member Function Documentation

AddHelpers()

QWidget * Isis::GuiParameter::AddHelpers

(

QObject *

lo

)

Sets up helper button.

Definition at line 245 of file GuiParameter.cpp.

References Isis::FileName::expanded(), Isis::IException::Programmer, and RememberWidget().

Referenced by Isis::GuiFileNameParameter::GuiFileNameParameter().

Exclusions()

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

virtual

Return list of current exclusions.

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

Definition at line 239 of file GuiParameter.cpp.

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

IsEnabled()

bool Isis::GuiParameter::IsEnabled ( ) const

inline

Is the parameter enabled.

Definition at line 59 of file GuiParameter.h.

Referenced by Isis::Gui::InvokeHelper(), Isis::GuiBooleanParameter::IsModified(), IsModified(), Isis::Gui::StartProcess(), and Isis::Gui::UpdateCommandLine().

IsModified()

bool Isis::GuiParameter::IsModified ( )

virtual

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

Reimplemented in Isis::GuiBooleanParameter.

Definition at line 181 of file GuiParameter.cpp.

References IsEnabled().

Referenced by Isis::Gui::InvokeHelper(), Isis::Gui::StartProcess(), Isis::Gui::UpdateCommandLine(), Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().

Name()

QString Isis::GuiParameter::Name ( ) const

inline

Return the name of the parameter.

Definition at line 44 of file GuiParameter.h.

Referenced by Isis::Gui::InvokeHelper(), Isis::Gui::ResetParameters(), Isis::Gui::StartProcess(), Isis::Gui::UpdateCommandLine(), and Isis::Gui::UpdateExclusions().

RememberWidget()

void Isis::GuiParameter::RememberWidget

(

QWidget *

w

)

Add widgets to a list for enabling/disabling.

Definition at line 212 of file GuiParameter.cpp.

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

Set()

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

pure virtual

Implemented in Isis::GuiFileNameParameter.

SetEnabled()

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

Enable or disable the parameter.

Definition at line 217 of file GuiParameter.cpp.

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

SetToCurrent()

void Isis::GuiParameter::SetToCurrent

(

)

Change the parameter to the current user interface value.

Definition at line 171 of file GuiParameter.cpp.

References SetToDefault().

SetToDefault()

void Isis::GuiParameter::SetToDefault

(

)

Change the parameter to the default value.

Definition at line 158 of file GuiParameter.cpp.

Referenced by SetToCurrent().

Type()

ParameterType Isis::GuiParameter::Type ( )

inline

Definition at line 77 of file GuiParameter.h.

Update()

void Isis::GuiParameter::Update

(

)

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

Definition at line 196 of file GuiParameter.cpp.

Referenced by Isis::Gui::Gui(), Isis::Gui::ResetParameters(), Isis::Gui::StartProcess(), Isis::Gui::UpdateHistory(), and Isis::Gui::UpdateParameters().

Value()

virtual QString Isis::GuiParameter::Value ( )

pure virtual

Implemented in Isis::GuiFileNameParameter.

Member Data Documentation

p_fileButton

QToolButton* Isis::GuiParameter::p_fileButton

protected

Definition at line 83 of file GuiParameter.h.

p_group

int Isis::GuiParameter::p_group

protected

Definition at line 86 of file GuiParameter.h.

p_helperMenu

QMenu* Isis::GuiParameter::p_helperMenu

private

Definition at line 98 of file GuiParameter.h.

p_label

QLabel* Isis::GuiParameter::p_label

protected

Definition at line 91 of file GuiParameter.h.

p_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit

protected

Definition at line 84 of file GuiParameter.h.

p_name

QString Isis::GuiParameter::p_name

protected

Definition at line 88 of file GuiParameter.h.

p_param

int Isis::GuiParameter::p_param

protected

Definition at line 87 of file GuiParameter.h.

p_type

ParameterType Isis::GuiParameter::p_type

protected

Definition at line 95 of file GuiParameter.h.

p_ui

UserInterface* Isis::GuiParameter::p_ui

protected

Definition at line 89 of file GuiParameter.h.

p_widgetList

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

protected

Definition at line 93 of file GuiParameter.h.

---

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

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