AbstractFeature Class Reference

#include <abstractfeature.h>

Inheritance diagram for AbstractFeature:

StlFeatureWrapper List of all members.

Public Member Functions

 AbstractFeature (QObject *parent=0)
virtual ~AbstractFeature ()
virtual QByteArray key () const=0
virtual QString title () const=0
virtual QString description () const=0
virtual FeatureResultT calcValue (const Stroke &stroke, bool *ok=0) const=0

Constructor & Destructor Documentation

AbstractFeature::AbstractFeature ( QObject *  parent = 0  )  [inline]

virtual AbstractFeature::~AbstractFeature (  )  [inline, virtual]


Member Function Documentation

QByteArray AbstractFeature::key (  )  const [pure virtual]

Returns the feature's "key". This is used for identifying features for purposes such as recording the types that a trained recogniser depends on and also for use in "factories".

This string should only contain lower-case characters. All string matching performed with it will be case-insensitive.

Note: This does not return a (const) reference for the sake of "wrappers" (e.g. JavaFeatureWrapper and StlFeatureWrapper), which may have to convert the string from a different structure, usually with the use of a temporary variable. Qt's implicit sharing will help performance.

Implemented in StlFeatureWrapper.

QString AbstractFeature::title (  )  const [pure virtual]

Returns the feature's "title". This is used in the application's user interface to label the feature in a human friendly / readable manner.

Note: This does not return a (const) reference for the sake of "wrappers" (e.g. JavaFeatureWrapper and StlFeatureWrapper), which may have to convert the string from a different structure, usually with the use of a temporary variable. Qt's implicit sharing will help performance.

Implemented in StlFeatureWrapper.

QString AbstractFeature::description (  )  const [pure virtual]

Returns the feature's "description". This is used in the application's user interface to provide more information to the user about the feature.

A subset of HTML may be used, such as to make the text bold and change its colour, size and alignment. Please see the Qt documentation for more details on its HTML support.

Note: This does not return a (const) reference for the sake of "wrappers" (e.g. JavaFeatureWrapper and StlFeatureWrapper), which may have to convert the string from a different structure, usually with the use of a temporary variable. Qt's implicit sharing will help performance.

Implemented in StlFeatureWrapper.

virtual FeatureResultT AbstractFeature::calcValue ( const Stroke stroke,
bool *  ok = 0 
) const [pure virtual]

Implemented in StlFeatureWrapper.


The documentation for this class was generated from the following files:
Generated on Mon Jul 30 09:46:51 2007 for Digest by  doxygen 1.5.2