Optika GUI Toolik Version of the Day
Public Member Functions
Optika::GenericArrayWidget< S > Class Template Reference

An Abstract base class for both 2D and 1D ArrayWidgets. More...

#include <Optika_ArrayWidget.hpp>

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

List of all members.

Public Member Functions

const QString getType () const
 Gets the type of array being edited.
const QString getName () const
 Returns the name of the parameter being edits.
const RCP< const
ParameterEntryValidator
getEntryValidator () const
 Returns the validator being used on the array.
virtual void accept ()=0
 called when the user is done entering data into the widget. MUST BE IMPLEMENTED AS A SLOT IN CONCRETE SUBCLASSES!

Constructors

 GenericArrayWidget (QString name, QString type, const RCP< const ParameterEntryValidator > validator, QWidget *parent=0)
 Constructs a GenericArrayWidget.

Protected Functions

virtual void setupArrayLayout ()
 Sets up the layout for the arrayContainer, including adding what ever editing widget should be used for the particual type of array.
virtual QLayout * getArrayLayout ()=0
 Get's the layout to be used for the array container in the widget.
virtual void doAcceptWork ()=0
 Gathers all the user inputed data and closes the dialog.

Protected Members

QWidget * arrayContainer
 The widget containing all of the editing widgets (e.g. QLineEdits, and QSpinBoxes) that comprise the array editor.

Private Members

QString type
 The type of array.
QString name
RCP< const
ParameterEntryValidator
entryValidator
 The validator being used on the array.

Detailed Description

template<class S>
class Optika::GenericArrayWidget< S >

An Abstract base class for both 2D and 1D ArrayWidgets.

Note the absence of the Q_OBJECT macro. This is becuase classes using the Q_OBJECT macro can't be templated (bummer). The macro is therfore present in the subclasses.

Definition at line 74 of file Optika_ArrayWidget.hpp.


Constructor & Destructor Documentation

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

Constructs a GenericArrayWidget.

Parameters:
nameThe name of the parameter beting edited.
typeThe arrays template type.
validatorThe validator to be used on the Array.
parentThe parent widget.

Definition at line 197 of file Optika_ArrayWidget.hpp.


Member Function Documentation

template<class S>
const QString Optika::GenericArrayWidget< S >::getType ( ) const [inline]

Gets the type of array being edited.

Returns:
The type of array being edited.

Definition at line 102 of file Optika_ArrayWidget.hpp.

template<class S>
const QString Optika::GenericArrayWidget< S >::getName ( ) const [inline]

Returns the name of the parameter being edits.

Definition at line 109 of file Optika_ArrayWidget.hpp.

template<class S>
const RCP<const ParameterEntryValidator> Optika::GenericArrayWidget< S >::getEntryValidator ( ) const [inline]

Returns the validator being used on the array.

Definition at line 116 of file Optika_ArrayWidget.hpp.

template<class S>
virtual void Optika::GenericArrayWidget< S >::accept ( ) [pure virtual]
template<class S>
virtual void Optika::GenericArrayWidget< S >::setupArrayLayout ( ) [inline, protected, virtual]

Sets up the layout for the arrayContainer, including adding what ever editing widget should be used for the particual type of array.

Definition at line 138 of file Optika_ArrayWidget.hpp.

template<class S>
virtual QLayout* Optika::GenericArrayWidget< S >::getArrayLayout ( ) [protected, pure virtual]
template<class S>
virtual void Optika::GenericArrayWidget< S >::doAcceptWork ( ) [protected, pure virtual]

Member Data Documentation

template<class S>
QWidget* Optika::GenericArrayWidget< S >::arrayContainer [protected]

The widget containing all of the editing widgets (e.g. QLineEdits, and QSpinBoxes) that comprise the array editor.

Definition at line 168 of file Optika_ArrayWidget.hpp.

template<class S>
QString Optika::GenericArrayWidget< S >::type [private]

The type of array.

Definition at line 181 of file Optika_ArrayWidget.hpp.

template<class S>
QString Optika::GenericArrayWidget< S >::name [private]

The name of the Parameter being edited.

Definition at line 186 of file Optika_ArrayWidget.hpp.

template<class S>
RCP<const ParameterEntryValidator> Optika::GenericArrayWidget< S >::entryValidator [private]

The validator being used on the array.

Definition at line 191 of file Optika_ArrayWidget.hpp.


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