casa
$Rev:20696$
|
Abstract parent class of any panels that accept user input for values. More...
#include <ValuePanel.qo.h>
Public Member Functions | |
ValuePanel (String paramName, const RecordInterface ¶mRecord) | |
Constructor that takes the parameter name and a reference to the record detailing its properties. | |
virtual | ~ValuePanel () |
Destructor. | |
virtual pair< bool, String > | valueIsValid ()=0 |
Abstract Methods //. | |
virtual DataType | type ()=0 |
Returns the type of the current value. | |
virtual void | getValue (String name, Record &record)=0 |
Inserts the entered value into the given record with the given name. | |
virtual void | setValue (const RecordInterface &rec, RecordFieldId id)=0 |
Sets the current value to the one given in the record with the given id. | |
Static Public Member Functions | |
static ValuePanel * | create (String paramName, const RecordInterface ¶mRecord) |
Factory Methods //. | |
Protected Member Functions | |
vector< String > | allowedVector () |
Returns the allowed vector in m_paramRecord in a useful format. | |
Protected Attributes | |
String | m_paramName |
Parameter name. | |
const RecordInterface & | m_paramRecord |
Parameter record. |
Abstract parent class of any panels that accept user input for values.
Definition at line 42 of file ValuePanel.qo.h.
casa::ValuePanel::ValuePanel | ( | String | paramName, |
const RecordInterface & | paramRecord | ||
) |
Constructor that takes the parameter name and a reference to the record detailing its properties.
virtual casa::ValuePanel::~ValuePanel | ( | ) | [virtual] |
Destructor.
vector<String> casa::ValuePanel::allowedVector | ( | ) | [protected] |
Returns the allowed vector in m_paramRecord in a useful format.
static ValuePanel* casa::ValuePanel::create | ( | String | paramName, |
const RecordInterface & | paramRecord | ||
) | [static] |
Factory Methods //.
Creates and returns a ValuePanel subclass instance appropriate for the given parameter. Right now, it only returns a StandardValuePanel, but in the future when specialized panels are used, this will be where the correct type is transparently created and returned.
Inserts the entered value into the given record with the given name.
Implemented in casa::StandardValuePanel.
virtual void casa::ValuePanel::setValue | ( | const RecordInterface & | rec, |
RecordFieldId | id | ||
) | [pure virtual] |
Sets the current value to the one given in the record with the given id.
Implemented in casa::StandardValuePanel.
virtual DataType casa::ValuePanel::type | ( | ) | [pure virtual] |
Returns the type of the current value.
Implemented in casa::StandardValuePanel.
virtual pair<bool, String> casa::ValuePanel::valueIsValid | ( | ) | [pure virtual] |
Abstract Methods //.
Returns whether or not the currently inputted value is true or not. If invalid, the String contains the reason(s), newline-separated.
Implemented in casa::StandardValuePanel.
String casa::ValuePanel::m_paramName [protected] |
Parameter name.
Definition at line 81 of file ValuePanel.qo.h.
const RecordInterface& casa::ValuePanel::m_paramRecord [protected] |
Parameter record.
Definition at line 84 of file ValuePanel.qo.h.