OFX::StringParamDescriptor Class Reference

Wraps up a string param. More...

#include <ofxsParam.h>

Inheritance diagram for OFX::StringParamDescriptor:

Collaboration diagram for OFX::StringParamDescriptor:

Public Member Functions
void	setDefault (const std::string &v)
	set the default value, default is 0
void	setStringType (StringTypeEnum v)
	sets the kind of the string param, defaults to eStringSingleLine
void	setFilePathExists (bool v)
	if the string param is a file path, say that we are picking an existing file, rather than posibly specifying a new one, defaults to true
Protected Member Functions
	mDeclareProtectedAssignAndCC (StringParamDescriptor)
	StringParamDescriptor (void)
	StringParamDescriptor (const std::string &name, OfxPropertySetHandle props)
	hidden constructor
Friends
class	ParamSetDescriptor

---

Detailed Description

Wraps up a string param.

Definition at line 297 of file ofxsParam.h.

---

Constructor & Destructor Documentation

OFX::StringParamDescriptor::StringParamDescriptor

(

void

)

[inline, protected]

Definition at line 301 of file ofxsParam.h.

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

hidden constructor

hidden ctor

Definition at line 630 of file ofxsParams.cpp.

---

Member Function Documentation

OFX::StringParamDescriptor::mDeclareProtectedAssignAndCC

(

StringParamDescriptor

)

[protected]

void OFX::StringParamDescriptor::setDefault

(

const std::string &

v

)

set the default value, default is 0

Definition at line 635 of file ofxsParams.cpp.

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

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

Here is the call graph for this function:

void OFX::StringParamDescriptor::setFilePathExists

(

bool

v

)

if the string param is a file path, say that we are picking an existing file, rather than posibly specifying a new one, defaults to true

if the string param is a file path, say that we are picking an existing file, defaults to true

Definition at line 664 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::StringParamDescriptor::setStringType

(

StringTypeEnum

v

)

sets the kind of the string param, defaults to eStringSingleLine

Definition at line 641 of file ofxsParams.cpp.

References OFX::eStringTypeDirectoryPath, OFX::eStringTypeFilePath, OFX::eStringTypeLabel, OFX::eStringTypeMultiLine, OFX::eStringTypeSingleLine, OFX::ParamDescriptor::getProps(), kOfxParamPropStringMode, kOfxParamStringIsDirectoryPath, kOfxParamStringIsFilePath, kOfxParamStringIsLabel, kOfxParamStringIsMultiLine, kOfxParamStringIsSingleLine, and OFX::PropertySet::propSetString().

Referenced by tuttle::plugin::describeReaderParamsInContext(), 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 307 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