USGS

Isis 3.0 Object Programmers' Reference

 Home
Public Types | Signals | Public Member Functions | Protected Attributes | Private Attributes | List of all members
Isis::GuiStringParameter Class 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)
 
QString Value ()
 
void Set (QString newValue)
 
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 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
 

Private Attributes

QLineEdit * p_lineEdit
 

Detailed Description

Author
????-??-?? Unknown

Definition at line 17 of file GuiStringParameter.h.

Member Function Documentation

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

Sets up helper button.

Definition at line 261 of file GuiParameter.cpp.

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

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

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

Return list of current exclusions.

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

Definition at line 255 of file GuiParameter.cpp.

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

bool Isis::GuiParameter::IsEnabled ( ) const
inlineinherited

Is the parameter enabled.

Definition at line 75 of file GuiParameter.h.

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

bool Isis::GuiParameter::IsModified ( )
virtualinherited

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

Reimplemented in Isis::GuiBooleanParameter.

Definition at line 197 of file GuiParameter.cpp.

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

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

QString Isis::GuiParameter::Name ( ) const
inlineinherited

Return the name of the parameter.

Definition at line 60 of file GuiParameter.h.

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

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

Add widgets to a list for enabling/disabling.

Definition at line 228 of file GuiParameter.cpp.

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

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

Enable or disable the parameter.

Definition at line 233 of file GuiParameter.cpp.

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

void Isis::GuiParameter::SetToCurrent ( )
inherited

Change the parameter to the current user interface value.

Definition at line 187 of file GuiParameter.cpp.

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

void Isis::GuiParameter::SetToDefault ( )
inherited

Change the parameter to the default value.

Definition at line 174 of file GuiParameter.cpp.

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

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

void Isis::GuiParameter::Update ( )
inherited

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

Definition at line 212 of file GuiParameter.cpp.

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

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

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