#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

Private Attributes
QMenu *	p_helperMenu

Detailed Description

Author: 2006-10-31 ???

History

2009-11-10 Mackenzie Boyd - Moved SelectFile method up to parent class GuiParameter, also moved member pointers to QToolButton and QLineEdit up.

2009-12-15 Travis Addair - Fixed bug with button for opening file dialog, made this class a parent for GuiCubeParameter, and moved SelectFile method back to this class, no longer prompting users to confirm overwriting a file.

2010-07-19 Jeannie Walldren - Modified SelectFile() method to allow users to view files in the directory. Updated documentation.

Definition at line 32 of file GuiFilenameParameter.h.

Member Enumeration Documentation

◆ ParameterType

enum Isis::GuiParameter::ParameterType

inherited

Definition at line 73 of file GuiParameter.h.

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

Definition at line 29 of file GuiFilenameParameter.cpp.

References Isis::GuiParameter::AddHelpers(), Isis::FileName::expanded(), IsisAml::HelpersSize(), Isis::GuiParameter::RememberWidget(), and SelectFile().

◆ ~GuiFileNameParameter()

Isis::GuiFileNameParameter::~GuiFileNameParameter ( )

Destructor of GuiFileNameParameter object.

Definition at line 64 of file GuiFilenameParameter.cpp.

Member Function Documentation

◆ AddHelpers()

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

inherited

Sets up helper button.

Definition at line 245 of file GuiParameter.cpp.

References Isis::FileName::expanded(), IsisAml::HelperBrief(), IsisAml::HelperButtonName(), IsisAml::HelperDescription(), IsisAml::HelperFunction(), IsisAml::HelperIcon(), IsisAml::HelpersSize(), Isis::IException::Programmer, and Isis::GuiParameter::RememberWidget().

Referenced by GuiFileNameParameter().

◆ Exclusions()

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

virtualinherited

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

inlineinherited

Is the parameter enabled.

Definition at line 59 of file GuiParameter.h.

Referenced by Isis::GuiParameter::IsModified().

◆ IsModified()

bool Isis::GuiParameter::IsModified ( )

virtualinherited

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

Reimplemented in Isis::GuiBooleanParameter.

Definition at line 181 of file GuiParameter.cpp.

References Isis::GuiParameter::IsEnabled(), IsisAml::ParamDefault(), and IsisAml::ParamInternalDefault().

Referenced by Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().

◆ Name()

QString Isis::GuiParameter::Name ( ) const

inlineinherited

Return the name of the parameter.

Definition at line 44 of file GuiParameter.h.

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

◆ RememberWidget()

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

inherited

Add widgets to a list for enabling/disabling.

Definition at line 212 of file GuiParameter.cpp.

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

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

History

2007-05-16 Tracie Sucharski - For files located in CWD, do not include path in the lineEdit.

2007-06-05 Steven Koechle - Corrected problem where output FileName was being opened not saved. Defaulted to output mode if not specified.

2009-11-02 Mackenzie Boyd - Corrected building of filter string to match GuiCubeParameter.cpp and, if no filters specified, to specify "Any(*)" not ";;Any(*)" as it had been doing.

2010-07-19 Jeannie Walldren - Modified to allow users to view files in the directory.

Definition at line 105 of file GuiFilenameParameter.cpp.

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

Definition at line 72 of file GuiFilenameParameter.cpp.

Referenced by SelectFile().

◆ SetEnabled()

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

inherited

Enable or disable the parameter.

Definition at line 217 of file GuiParameter.cpp.

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

◆ SetToCurrent()

void Isis::GuiParameter::SetToCurrent ( )

inherited

Change the parameter to the current user interface value.

Definition at line 171 of file GuiParameter.cpp.

References IsisAml::GetAsString(), Isis::GuiParameter::SetToDefault(), and IsisAml::WasEntered().

◆ SetToDefault()

void Isis::GuiParameter::SetToDefault ( )

inherited

Change the parameter to the default value.

Definition at line 158 of file GuiParameter.cpp.

References IsisAml::ParamDefault(), and IsisAml::ParamInternalDefault().

Referenced by Isis::GuiParameter::SetToCurrent().

◆ Type()

ParameterType Isis::GuiParameter::Type ( )

inlineinherited

Definition at line 77 of file GuiParameter.h.

◆ Update()

void Isis::GuiParameter::Update ( )

inherited

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

Definition at line 196 of file GuiParameter.cpp.

References IsisAml::GetAsString(), IsisAml::ParamDefault(), IsisAml::ParamInternalDefault(), and IsisAml::WasEntered().

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

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

Definition at line 82 of file GuiFilenameParameter.cpp.

Referenced by Isis::GuiCubeParameter::ViewCube(), and Isis::GuiCubeParameter::ViewLabel().

Member Data Documentation

◆ p_fileButton

QToolButton* Isis::GuiParameter::p_fileButton

protectedinherited

Definition at line 83 of file GuiParameter.h.

◆ p_group

int Isis::GuiParameter::p_group

protectedinherited

Definition at line 86 of file GuiParameter.h.

◆ p_helperMenu

QMenu* Isis::GuiParameter::p_helperMenu

privateinherited

Definition at line 98 of file GuiParameter.h.

◆ p_label

QLabel* Isis::GuiParameter::p_label

protectedinherited

Definition at line 91 of file GuiParameter.h.

◆ p_lineEdit

QLineEdit* Isis::GuiParameter::p_lineEdit

protectedinherited

Definition at line 84 of file GuiParameter.h.

◆ p_name

QString Isis::GuiParameter::p_name

protectedinherited

Definition at line 88 of file GuiParameter.h.

◆ p_param

int Isis::GuiParameter::p_param

protectedinherited

Definition at line 87 of file GuiParameter.h.

◆ p_type

ParameterType Isis::GuiParameter::p_type

protectedinherited

Definition at line 95 of file GuiParameter.h.

◆ p_ui

UserInterface* Isis::GuiParameter::p_ui

protectedinherited

Definition at line 89 of file GuiParameter.h.

◆ p_widgetList

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

protectedinherited

Definition at line 93 of file GuiParameter.h.

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

src/base/objs/Gui/GuiFilenameParameter.h
src/base/objs/Gui/GuiFilenameParameter.cpp

Public Types

Signals

Public Member Functions

Protected Slots

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ParameterType

Constructor & Destructor Documentation

◆ GuiFileNameParameter()

◆ ~GuiFileNameParameter()

Member Function Documentation

◆ AddHelpers()

◆ Exclusions()

◆ IsEnabled()

◆ IsModified()

◆ Name()

◆ RememberWidget()

◆ SelectFile

◆ Set()

◆ SetEnabled()

◆ SetToCurrent()

◆ SetToDefault()

◆ Type()

◆ Update()

◆ Value()

Member Data Documentation

◆ p_fileButton

◆ p_group

◆ p_helperMenu

◆ p_label

◆ p_lineEdit

◆ p_name

◆ p_param

◆ p_type

◆ p_ui

◆ p_widgetList