Optika Development
Optika::Generic1DArrayWidget< S > Class Template Reference

A templated abstract base class for all 1D array editing widgets. More...

#include <Optika_ArrayWidget.hpp>

Inheritance diagram for Optika::Generic1DArrayWidget< S >:
Inheritance graph
[legend]
Collaboration diagram for Optika::Generic1DArrayWidget< S >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Constructor
 Generic1DArrayWidget (QString name, QString type, const RCP< const ParameterEntryValidator > validator, QWidget *parent=0)
 Constructs a Generic1DArrayWidget.
Attribute/Query Methods
const Array< S > getData () const
Miscellaneous
void initData (Array< S > array)
 Initializes all of the data in the array widget so when it pops up, the individual widgets are populate with their current values in the array. Also, sets the baseArray to array.
virtual QWidget * getEditorWidget (int index)=0
 Gets the widget to be used as an editor for each entry in the array.
virtual Array< S > getArrayFromWidgets ()=0
 Get a new array reflecting the current values entered in the widgets.

Protected Types

Protected types
typedef std::vector< QWidget * > WVector
 Convienece typedef. Represents an array of QWidgets.

Protected Member Functions

Overriden from GenericArrayWidget
void doAcceptWork ()
 

Protected Attributes

Protected members
WVector widgetVector
 Conatins the editing widgets (e.g. QLineEdits and QSpinBoxes) comprising the array editor.
Array< S > baseArray
 The array to be edited.

Detailed Description

template<class S>
class Optika::Generic1DArrayWidget< S >

A templated abstract base class for all 1D array editing widgets.

Array


Constructor & Destructor Documentation

template<class S >
Optika::Generic1DArrayWidget< S >::Generic1DArrayWidget ( QString  name,
QString  type,
const RCP< const ParameterEntryValidator >  validator,
QWidget *  parent = 0 
)

Constructs a Generic1DArrayWidget.

Parameters:
nameThe name of the parmaeter being edited.
typeThe array's template type.
validatorThe validator on the array (null if there is none).
parentThe parent widget.

Member Function Documentation

template<class S>
virtual Array<S> Optika::Generic1DArrayWidget< S >::getArrayFromWidgets ( ) [pure virtual]

Get a new array reflecting the current values entered in the widgets.

Returns:
A new array reflecting the currecnt values entered in the widgets.

Implemented in Optika::IntArrayWidget, Optika::ShortArrayWidget, Optika::DoubleArrayWidget, Optika::FloatArrayWidget, and Optika::StringArrayWidget.

template<class S>
const Array<S> Optika::Generic1DArrayWidget< S >::getData ( ) const [inline]

Return the array backing this widget.

Parameters:
Thearray backing this widget.
template<class S>
void Optika::Generic1DArrayWidget< S >::initData ( Array< S >  array) [inline]

Initializes all of the data in the array widget so when it pops up, the individual widgets are populate with their current values in the array. Also, sets the baseArray to array.

Parameters:
arrayThe array that should be used to populate the individual widgets making up the ArrayWidget.

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs