OFX::ChoiceParamDescriptor Class Reference

Wraps up a choice param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::ChoiceParamDescriptor:

Collaboration diagram for OFX::ChoiceParamDescriptor:

Public Member Functions
void	setDefault (int v)
	set the default value
void	appendOption (const std::string &scriptName, const std::string &label="")
	append an option, default is to have not there
int	getNOptions (void) const
	how many options do we have
void	resetOptions (void)
	clear all the options so as to add some new ones in
Protected Member Functions
	mDeclareProtectedAssignAndCC (ChoiceParamDescriptor)
	ChoiceParamDescriptor (void)
	ChoiceParamDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up a choice param.

Definition at line 586 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::ChoiceParamDescriptor::ChoiceParamDescriptor

(

void

)

[inline, protected]

Definition at line 590 of file ofxsParam.h.

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

hidden constructor

Definition at line 593 of file ofxsParams.cpp.

---

Member Function Documentation

void OFX::ChoiceParamDescriptor::appendOption	(	const std::string &	scriptName,
		const std::string &	label = ""
	)

append an option, default is to have not there

set the default value

Definition at line 612 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropChoiceLabelOption, kOfxParamPropChoiceOption, OFX::PropertySet::propGetDimension(), and OFX::PropertySet::propSetString().

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

Here is the call graph for this function:

int OFX::ChoiceParamDescriptor::getNOptions

(

void

)

const

how many options do we have

Definition at line 604 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropChoiceOption, and OFX::PropertySet::propGetDimension().

Here is the call graph for this function:

OFX::ChoiceParamDescriptor::mDeclareProtectedAssignAndCC

(

ChoiceParamDescriptor

)

[protected]

void OFX::ChoiceParamDescriptor::resetOptions

(

void

)

clear all the options so as to add some new ones in

set the default value

Definition at line 621 of file ofxsParams.cpp.

References OFX::ParamDescriptor::getProps(), kOfxParamPropChoiceOption, and OFX::PropertySet::propReset().

Here is the call graph for this function:

void OFX::ChoiceParamDescriptor::setDefault

(

int

v

)

set the default value

Definition at line 598 of file ofxsParams.cpp.

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

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

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class ParamSetDescriptor [friend]

Reimplemented from OFX::ValueParamDescriptor.

Definition at line 597 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