Isis::GuiFileNameParameter Class Reference

#include <GuiFilenameParameter.h>

Inheritance diagram for Isis::GuiFileNameParameter:

Collaboration diagram for Isis::GuiFileNameParameter:

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

Signals
void	ValueChanged ()
void	HelperTrigger (const QString &)

Public Member Functions
	GuiFileNameParameter (QGridLayout *grid, UserInterface &ui, int group, int param)
	Construct a GuiFileNameParameter object.
	~GuiFileNameParameter ()
	Destructor of GuiFileNameParameter 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

GuiFileNameParameter()

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

Construct a GuiFileNameParameter object.

Parameters

grid	Pointer to QGridLayout
ui	User interface object
group	Index of group
param	Index of parameter

References Isis::GuiParameter::AddHelpers(), Isis::FileName::expanded(), Isis::GuiParameter::FileNameWidget, IsisAml::HelpersSize(), Isis::GuiParameter::p_fileButton, Isis::GuiParameter::p_lineEdit, Isis::GuiParameter::p_type, Isis::GuiParameter::p_ui, Isis::GuiParameter::RememberWidget(), SelectFile(), and Isis::GuiParameter::ValueChanged().

~GuiFileNameParameter()

Isis::GuiFileNameParameter::~GuiFileNameParameter

(

)

Destructor of GuiFileNameParameter object.

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

SelectFile

void Isis::GuiFileNameParameter::SelectFile ( )

protectedvirtualslot

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::GuiParameter::p_fileButton, Isis::GuiParameter::p_group, Isis::GuiParameter::p_lineEdit, Isis::GuiParameter::p_param, Isis::GuiParameter::p_ui, IsisAml::ParamFileMode(), IsisAml::ParamFilter(), IsisAml::ParamInternalDefault(), IsisAml::ParamPath(), and Set().

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

Set()

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

virtual

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

Value()

QString Isis::GuiFileNameParameter::Value ( )

virtual

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(), 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(), GuiFileNameParameter(), Isis::GuiParameter::GuiParameter(), and 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(), 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_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit

protectedinherited

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

• /Users/chkim/repos/ISIS3/isis/src/base/objs/Gui/GuiFilenameParameter.h
• /Users/chkim/repos/ISIS3/isis/src/base/objs/Gui/GuiFilenameParameter.cpp