TuttleOFX  1
Public Member Functions | Protected Member Functions | Private Member Functions | Friends
OFX::StringParam Class Reference

Wraps up a string param. More...

#include <ofxsParam.h>

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

Public Member Functions

void getDefault (std::string &v) const
 get the default value
std::string getDefault () const
void setDefault (const std::string &v)
 set the default value
void getPointerValue (char **cStr) const
 get value
void getValue (std::string &v) const
std::string getValue () const
void setValue (const std::string &v)
 set value
void getPointerValueAtTime (OfxTime time, char **cStr) const
 get the value at a time
void getValueAtTime (OfxTime time, std::string &v) const
 get the value at a time
std::string getValueAtTime (OfxTime time) const
void setValueAtTime (OfxTime time, const std::string &v)
 set the value at a time, implicitly adds a keyframe
StringTypeEnum getStringType () const

Protected Member Functions

 StringParam (const ParamSet *paramSet, const std::string &name, OfxParamHandle handle)
 hidden constructor

Private Member Functions

 mDeclareProtectedAssignAndCC (StringParam)
 StringParam (void)

Friends

class ParamSet

Detailed Description

Wraps up a string param.

Definition at line 1495 of file ofxsParam.h.

Constructor & Destructor Documentation

OFX::StringParam::StringParam ( void  ) [inline, private]

Definition at line 1499 of file ofxsParam.h.

OFX::StringParam::StringParam ( const ParamSet *  paramSet,
const std::string &  name,
OfxParamHandle  handle 
) [protected]

hidden constructor

Definition at line 2051 of file ofxsParams.cpp.

Member Function Documentation

void OFX::StringParam::getDefault ( std::string &  v) const

get the default value

het the default value

Definition at line 2056 of file ofxsParams.cpp.

References OFX::Attribute::getProps(), kOfxParamPropDefault, and OFX::PropertySet::propGetString().

Here is the call graph for this function:

std::string OFX::StringParam::getDefault ( void  ) const [inline]

Definition at line 1510 of file ofxsParam.h.

References getDefault().

Referenced by getDefault().

Here is the call graph for this function:

void OFX::StringParam::getPointerValue ( char **  cStr) const

get value

Definition at line 2068 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValue, and OFX::throwSuiteStatusException().

Referenced by getValue().

Here is the call graph for this function:

void OFX::StringParam::getPointerValueAtTime ( OfxTime  time,
char **  cStr 
) const

get the value at a time

Definition at line 2090 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramGetValueAtTime, and OFX::throwSuiteStatusException().

Referenced by getValueAtTime().

Here is the call graph for this function:

StringTypeEnum OFX::StringParam::getStringType ( ) const

Definition at line 2114 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::StringParam::getValue ( std::string &  v) const

Definition at line 2074 of file ofxsParams.cpp.

References getPointerValue().

Referenced by tuttle::plugin::ReaderPlugin::changedParam(), tuttle::plugin::lut::LutPlugin::changedParam(), tuttle::plugin::outputBuffer::OutputBufferPlugin::changedParam(), tuttle::plugin::WriterPlugin::changedParam(), tuttle::plugin::inputBuffer::InputBufferPlugin::changedParam(), tuttle::plugin::av::reader::AVReaderPlugin::ensureVideoIsOpen(), tuttle::plugin::WriterPlugin::getAbsoluteDirectory(), tuttle::plugin::ReaderPlugin::getAbsoluteFilenameAt(), tuttle::plugin::WriterPlugin::getAbsoluteFilenameAt(), tuttle::plugin::ReaderPlugin::getAbsoluteFirstFilename(), tuttle::plugin::WriterPlugin::getAbsoluteFirstFilename(), tuttle::plugin::outputBuffer::OutputBufferPlugin::getProcessParams(), tuttle::plugin::ctl::CTLPlugin::getProcessParams(), tuttle::plugin::seExpr::SeExprPlugin::getProcessParams(), tuttle::plugin::av::reader::AVReaderPlugin::getProcessParams(), tuttle::plugin::ocio::lut::OCIOLutPlugin::getProcessParams(), tuttle::plugin::dpx::writer::DPXWriterPlugin::getProcessParams(), tuttle::plugin::av::writer::AVWriterPlugin::getProcessParams(), tuttle::plugin::text::TextPlugin::getProcessParams(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::getProcessParams(), tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams(), tuttle::plugin::ReaderPlugin::ReaderPlugin(), tuttle::plugin::lut::LutPlugin::render(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::WriterPlugin::WriterPlugin().

Here is the call graph for this function:

std::string OFX::StringParam::getValue ( void  ) const [inline]

Definition at line 1519 of file ofxsParam.h.

References getValue().

Referenced by getValue().

Here is the call graph for this function:

void OFX::StringParam::getValueAtTime ( OfxTime  time,
std::string &  v 
) const

get the value at a time

Definition at line 2097 of file ofxsParams.cpp.

References getPointerValueAtTime().

Referenced by tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams().

Here is the call graph for this function:

std::string OFX::StringParam::getValueAtTime ( OfxTime  time) const [inline]

Definition at line 1529 of file ofxsParam.h.

References getValueAtTime().

Referenced by getValueAtTime().

Here is the call graph for this function:

OFX::StringParam::mDeclareProtectedAssignAndCC ( StringParam  ) [private]
void OFX::StringParam::setDefault ( const std::string &  v)

set the default value

Definition at line 2062 of file ofxsParams.cpp.

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

Here is the call graph for this function:

void OFX::StringParam::setValue ( const std::string &  v)

set value

Definition at line 2082 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValue, and OFX::throwSuiteStatusException().

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), tuttle::plugin::av::AVOptionPlugin< IOPlugin >::setParameters(), and tuttle::plugin::raw::reader::RawReaderPlugin::updateInfos().

Here is the call graph for this function:

void OFX::StringParam::setValueAtTime ( OfxTime  time,
const std::string &  v 
)

set the value at a time, implicitly adds a keyframe

Definition at line 2105 of file ofxsParams.cpp.

References OFX::Param::_paramHandle, OFX::Private::gParamSuite, OfxParameterSuiteV1::paramSetValueAtTime, OFX::throwHostMissingSuiteException(), and OFX::throwSuiteStatusException().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented from OFX::ValueParam.

Definition at line 1505 of file ofxsParam.h.

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