OFX::IntParamDescriptor Class Reference

Wraps up an integer param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::IntParamDescriptor:

Collaboration diagram for OFX::IntParamDescriptor:

Public Member Functions
void	setDefault (int v)
	set the default value, default is 0
void	setRange (int min, int max)
	set the hard min/max range, default is INT_MIN, INT_MAX
void	setDisplayRange (int min, int max)
	set the display min and max, default is to be the same as the range param
Protected Member Functions
	mDeclareProtectedAssignAndCC (IntParamDescriptor)
	IntParamDescriptor (void)
	IntParamDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up an integer param.

Definition at line 322 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::IntParamDescriptor::IntParamDescriptor

(

void

)

[inline, protected]

Definition at line 326 of file ofxsParam.h.

OFX::IntParamDescriptor::IntParamDescriptor	(	const std::string &	name,
		OfxPropertySetHandle	props
	)		[protected]

hidden constructor

ctor

Definition at line 253 of file ofxsParams.cpp.

---

Member Function Documentation

OFX::IntParamDescriptor::mDeclareProtectedAssignAndCC

(

IntParamDescriptor

)

[protected]

void OFX::IntParamDescriptor::setDefault

(

int

v

)

set the default value, default is 0

Definition at line 258 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propSetInt().

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::IntParamDescriptor::setDisplayRange	(	int	min,
		int	max
	)

set the display min and max, default is to be the same as the range param

Definition at line 271 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropDisplayMax, kOfxParamPropDisplayMin, and OFX::PropertySet::propSetInt().

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

Here is the call graph for this function:

void OFX::IntParamDescriptor::setRange	(	int	min,
		int	max
	)

set the hard min/max range, default is INT_MIN, INT_MAX

Definition at line 264 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropMax, kOfxParamPropMin, and OFX::PropertySet::propSetInt().

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

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::ValueParamDescriptor.

Definition at line 332 of file ofxsParam.h.

---

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

• libraries/openfxHack/Support/include/ofxsParam.h
• libraries/openfxHack/Support/Library/ofxsParams.cpp