OFX::ParamDescriptor Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::ParamDescriptor:

List of all members.

---

Detailed Description

Base class for all param descriptors.

Public Member Functions
virtual	~ParamDescriptor ()
	dtor
ParamTypeEnum	getType (void) const
const std::string &	getName (void) const
	name
PropertySet &	getPropertySet ()
	Get the property set.
void	setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
	set the label properties
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 defined 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	setEnabled (bool v)
	set the secretness of the param, defaults to false
Protected Member Functions
	mDeclareProtectedAssignAndCC (ParamDescriptor)
	ParamDescriptor (void)
	ParamDescriptor (const std::string &name, ParamTypeEnum type, OfxPropertySetHandle props)
	ctor
Protected Attributes
std::string	_paramName
ParamTypeEnum	_paramType
PropertySet	_paramProps
Friends
class	ParamSetDescriptor

---

Constructor & Destructor Documentation

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

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

ctor

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

dtor

---

Member Function Documentation

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

name

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

Get the property set.

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

OFX::ParamDescriptor::mDeclareProtectedAssignAndCC (  ParamDescriptor   )  [protected]

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

set the secretness of the param, defaults to false

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

set the param hint

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

set the secretness of the param, defaults to false

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

set the label properties

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

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

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

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

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

---

Member Data Documentation

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

PropertySet OFX::ParamDescriptor::_paramProps [protected]

ParamTypeEnum OFX::ParamDescriptor::_paramType [protected]

---

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

• ofxsParam.h
• ofxsParams.cpp

---