TuttleOFX  1
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
OFX::ParamDescriptor Class Reference

Base class for all param descriptors. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::ParamDescriptor:
Inheritance graph
[legend]
Collaboration diagram for OFX::ParamDescriptor:
Collaboration graph
[legend]

Public Member Functions

virtual ~ParamDescriptor ()
 dtor
ParamTypeEnum getType (void) const
PropertySet & getProps ()
const PropertySet & getProps () const
const std::string & getName (void) const
 name
PropertySet & getPropertySet ()
 Get the property set.
const PropertySet & getPropertySet () const
void setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
 set the label properties in a plugin
void setLabel (const std::string &label)
void setHint (const std::string &hint)
 set the param hint
void setScriptName (const std::string &hint)
 set the script name, default is the name it was created with
void setIsSecret (bool v)
 set the secretness of the param, defaults to false
void setParent (const GroupParamDescriptor &v)
 set the group param that is the parent of this one, default is to be ungrouped at the root level
void setParent (const GroupParamDescriptor *v)
void setEnabled (bool v)
 whether the param is enabled, defaults to true
void setLayoutHint (const ELayoutHint layoutHint)

Protected Member Functions

 mDeclareProtectedAssignAndCC (ParamDescriptor)
 ParamDescriptor (void)
 ParamDescriptor (const std::string &name, ParamTypeEnum type, OfxPropertySetHandle props)
 hidden constructors

Protected Attributes

std::string _paramName
ParamTypeEnum _paramType
PropertySet _paramProps

Friends

class ParamSetDescriptor

Detailed Description

Base class for all param descriptors.

Definition at line 192 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::ParamDescriptor::ParamDescriptor ( void  ) [inline, protected]

Definition at line 196 of file ofxsParam.h.

OFX::ParamDescriptor::ParamDescriptor ( const std::string &  name,
ParamTypeEnum  type,
OfxPropertySetHandle  props 
) [protected]

hidden constructors

ctor

Definition at line 130 of file ofxsParams.cpp.

References OFX::eDummyParam, getProps(), and OFX::Validation::validateParameterProperties().

Here is the call graph for this function:

OFX::ParamDescriptor::~ParamDescriptor ( ) [virtual]

dtor

Definition at line 140 of file ofxsParams.cpp.

Member Function Documentation

const std::string& OFX::ParamDescriptor::getName ( void  ) const [inline]

name

Definition at line 218 of file ofxsParam.h.

References _paramName.

Referenced by OFX::PageParamDescriptor::addChild(), OFX::ImageEffectDescriptor::addClipPreferencesSlaveParam(), tuttle::plugin::av::addOptionsFromAVOption(), OFX::ValueParamDescriptor::setInteractDescriptor(), OFX::ParametricParamDescriptor::setInteractDescriptor(), OFX::ParamSetDescriptor::setPageParamOrder(), OFX::ParametricParamDescriptor::setParamSet(), and setParent().

PropertySet& OFX::ParamDescriptor::getPropertySet ( ) [inline]

Get the property set.

Definition at line 221 of file ofxsParam.h.

References _paramProps.

const PropertySet& OFX::ParamDescriptor::getPropertySet ( ) const [inline]

Definition at line 222 of file ofxsParam.h.

References _paramProps.

PropertySet& OFX::ParamDescriptor::getProps ( ) [inline]

Definition at line 214 of file ofxsParam.h.

References _paramProps.

Referenced by OFX::PageParamDescriptor::addChild(), OFX::ChoiceParamDescriptor::appendOption(), OFX::ChoiceParamDescriptor::getNOptions(), ParamDescriptor(), OFX::ChoiceParamDescriptor::resetOptions(), OFX::ValueParamDescriptor::setAnimates(), OFX::GroupParamDescriptor::setAsTab(), OFX::ValueParamDescriptor::setCacheInvalidation(), OFX::ValueParamDescriptor::setCanUndo(), OFX::StringParamDescriptor::setDefault(), OFX::IntParamDescriptor::setDefault(), OFX::Int2DParamDescriptor::setDefault(), OFX::Int3DParamDescriptor::setDefault(), OFX::DoubleParamDescriptor::setDefault(), OFX::Double2DParamDescriptor::setDefault(), OFX::Double3DParamDescriptor::setDefault(), OFX::RGBParamDescriptor::setDefault(), OFX::RGBAParamDescriptor::setDefault(), OFX::BooleanParamDescriptor::setDefault(), OFX::ChoiceParamDescriptor::setDefault(), OFX::CustomParamDescriptor::setDefault(), OFX::BaseDoubleParamDescriptor::setDigits(), OFX::ParametricParamDescriptor::setDimension(), OFX::ParametricParamDescriptor::setDimensionLabel(), OFX::Int2DParamDescriptor::setDimensionLabels(), OFX::Int3DParamDescriptor::setDimensionLabels(), OFX::Double2DParamDescriptor::setDimensionLabels(), OFX::Double3DParamDescriptor::setDimensionLabels(), OFX::IntParamDescriptor::setDisplayRange(), OFX::Int2DParamDescriptor::setDisplayRange(), OFX::Int3DParamDescriptor::setDisplayRange(), OFX::DoubleParamDescriptor::setDisplayRange(), OFX::Double2DParamDescriptor::setDisplayRange(), OFX::Double3DParamDescriptor::setDisplayRange(), OFX::BaseDoubleParamDescriptor::setDoubleType(), setEnabled(), OFX::ValueParamDescriptor::setEvaluateOnChange(), OFX::StringParamDescriptor::setFilePathExists(), setHint(), OFX::ParametricParamDescriptor::setIdentity(), OFX::BaseDoubleParamDescriptor::setIncrement(), OFX::ValueParamDescriptor::setInteractDescriptor(), OFX::ParametricParamDescriptor::setInteractDescriptor(), OFX::ValueParamDescriptor::setIsPersistant(), setIsSecret(), OFX::ParametricParamDescriptor::setLabel(), setLabels(), setLayoutHint(), OFX::GroupParamDescriptor::setOpen(), setParent(), OFX::IntParamDescriptor::setRange(), OFX::Int2DParamDescriptor::setRange(), OFX::Int3DParamDescriptor::setRange(), OFX::DoubleParamDescriptor::setRange(), OFX::Double2DParamDescriptor::setRange(), OFX::Double3DParamDescriptor::setRange(), OFX::ParametricParamDescriptor::setRange(), setScriptName(), OFX::StringParamDescriptor::setStringType(), and OFX::ParametricParamDescriptor::setUIColour().

const PropertySet& OFX::ParamDescriptor::getProps ( ) const [inline]

Definition at line 215 of file ofxsParam.h.

References _paramProps.

ParamTypeEnum OFX::ParamDescriptor::getType ( void  ) const [inline]

Definition at line 212 of file ofxsParam.h.

References _paramType.

OFX::ParamDescriptor::mDeclareProtectedAssignAndCC ( ParamDescriptor  ) [protected]
void OFX::ParamDescriptor::setEnabled ( bool  v)

whether the param is enabled, defaults to true

set the secretness of the param, defaults to false

Definition at line 170 of file ofxsParams.cpp.

References getProps(), kOfxParamPropEnabled, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ParamDescriptor::setHint ( const std::string &  hint)

set the param hint

Definition at line 152 of file ofxsParams.cpp.

References getProps(), kOfxParamPropHint, and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::av::addOptionsFromAVOption(), tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeSamplerParamsInContext(), and tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ParamDescriptor::setIsSecret ( bool  v)

set the secretness of the param, defaults to false

Definition at line 164 of file ofxsParams.cpp.

References getProps(), kOfxParamPropSecret, and OFX::PropertySet::propSetInt().

Referenced by tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), and tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ParamDescriptor::setLabel ( const std::string &  label) [inline]

Reimplemented in OFX::ParametricParamDescriptor.

Definition at line 226 of file ofxsParam.h.

References setLabels().

Referenced by tuttle::plugin::av::addOptionsFromAVOption(), tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), tuttle::plugin::describeSamplerParamsInContext(), and tuttle::plugin::describeWriterParamsInContext().

Here is the call graph for this function:

void OFX::ParamDescriptor::setLabels ( const std::string &  label,
const std::string &  shortLabel,
const std::string &  longLabel 
)

set the label properties in a plugin

set the label properties

Definition at line 144 of file ofxsParams.cpp.

References getProps(), kOfxPropLabel, kOfxPropLongLabel, kOfxPropShortLabel, and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::describeWriterParamsInContext(), and setLabel().

Here is the call graph for this function:

void OFX::ParamDescriptor::setLayoutHint ( const ELayoutHint  layoutHint)

Definition at line 175 of file ofxsParams.cpp.

References getProps(), kOfxParamPropLayoutHint, and OFX::PropertySet::propSetInt().

Here is the call graph for this function:

void OFX::ParamDescriptor::setParent ( const GroupParamDescriptor &  v)

set the group param that is the parent of this one, default is to be ungrouped at the root level

Definition at line 182 of file ofxsParams.cpp.

References getName(), getProps(), kOfxParamPropParent, and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::av::addOptionsFromAVOption().

Here is the call graph for this function:

void OFX::ParamDescriptor::setParent ( const GroupParamDescriptor *  v) [inline]

Definition at line 239 of file ofxsParam.h.

References setParent().

Referenced by setParent().

Here is the call graph for this function:

void OFX::ParamDescriptor::setScriptName ( const std::string &  hint)

set the script name, default is the name it was created with

set the script name, default is the name it was defined with

Definition at line 158 of file ofxsParams.cpp.

References getProps(), kOfxParamPropScriptName, and OFX::PropertySet::propSetString().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented in OFX::CustomParamDescriptor, OFX::ParametricParamDescriptor, OFX::PushButtonParamDescriptor, OFX::PageParamDescriptor, OFX::GroupParamDescriptor, OFX::ChoiceParamDescriptor, OFX::BooleanParamDescriptor, OFX::RGBAParamDescriptor, OFX::RGBParamDescriptor, OFX::Double3DParamDescriptor, OFX::Double2DParamDescriptor, OFX::DoubleParamDescriptor, OFX::BaseDoubleParamDescriptor, OFX::Int3DParamDescriptor, OFX::Int2DParamDescriptor, OFX::IntParamDescriptor, OFX::StringParamDescriptor, and OFX::ValueParamDescriptor.

Definition at line 206 of file ofxsParam.h.

Field Documentation

std::string OFX::ParamDescriptor::_paramName [protected]

Definition at line 199 of file ofxsParam.h.

Referenced by getName().

PropertySet OFX::ParamDescriptor::_paramProps [protected]

Definition at line 201 of file ofxsParam.h.

Referenced by getPropertySet(), and getProps().

ParamTypeEnum OFX::ParamDescriptor::_paramType [protected]

Definition at line 200 of file ofxsParam.h.

Referenced by getType().

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