OFX::ParamSetDescriptor Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::ParamSetDescriptor:

List of all members.

---

Detailed Description

Describes a set of properties.

Public Member Functions
virtual	~ParamSetDescriptor ()
	dtor
ParamDescriptor *	getParamDescriptor (const std::string &name) const
	tries to fetch a ParamDescriptor, returns 0 if it isn't there
void	setPageParamOrder (PageParamDescriptor &p)
	estabilishes the order of page params. Do it by calling it in turn for each page
IntParamDescriptor *	defineIntParam (const std::string &name)
	Define an integer param, only callable from describe in context.
Int2DParamDescriptor *	defineInt2DParam (const std::string &name)
	Define a 2D integer param.
Int3DParamDescriptor *	defineInt3DParam (const std::string &name)
	Define a 3D integer param.
DoubleParamDescriptor *	defineDoubleParam (const std::string &name)
	Define an double param, only callable from describe in context.
Double2DParamDescriptor *	defineDouble2DParam (const std::string &name)
	Define a 2D double param.
Double3DParamDescriptor *	defineDouble3DParam (const std::string &name)
	Define a 3D double param.
StringParamDescriptor *	defineStringParam (const std::string &name)
	Define a string param.
RGBAParamDescriptor *	defineRGBAParam (const std::string &name)
	Define a RGBA param.
RGBParamDescriptor *	defineRGBParam (const std::string &name)
	Define an RGB param.
BooleanParamDescriptor *	defineBooleanParam (const std::string &name)
	Define a Boolean param.
ChoiceParamDescriptor *	defineChoiceParam (const std::string &name)
	Define a Choice param.
GroupParamDescriptor *	defineGroupParam (const std::string &name)
	Define a group param.
PageParamDescriptor *	definePageParam (const std::string &name)
	Define a Page param.
PushButtonParamDescriptor *	definePushButtonParam (const std::string &name)
	Define a push button param.
CustomParamDescriptor *	defineCustomParam (const std::string &name)
	Define a custom param.
Protected Member Functions
	mDeclareProtectedAssignAndCC (ParamSetDescriptor)
void	defineRawParam (const std::string &name, ParamTypeEnum paramType, OfxPropertySetHandle &props)
	calls the raw OFX routine to define a param
template<class T>
bool	defineParamDescriptor (const std::string &name, ParamTypeEnum paramType, T *&paramPtr)
	Define a param descriptor of the given type.
	ParamSetDescriptor (void)
	hidden ctor
void	setParamSetHandle (OfxParamSetHandle h)
	set the param set handle
ParamDescriptor *	findPreviouslyDefinedParam (const std::string &name)
	if a param has been defined in this set, go find it
Protected Attributes
PropertySet	_paramSetProps
	Properties that belong to this param set.
OfxParamSetHandle	_paramSetHandle
	Parameter set handle.
std::map< std::string, ParamDescriptor * >	_definedParams
	Set of all previously defined parameters, defined on demand.

---

Constructor & Destructor Documentation

OFX::ParamSetDescriptor::ParamSetDescriptor (  void   )  [protected]

hidden ctor

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

dtor

---

Member Function Documentation

BooleanParamDescriptor * OFX::ParamSetDescriptor::defineBooleanParam (  const std::string &  name  )

Define a Boolean param.

ChoiceParamDescriptor * OFX::ParamSetDescriptor::defineChoiceParam (  const std::string &  name  )

Define a Choice param.

CustomParamDescriptor * OFX::ParamSetDescriptor::defineCustomParam (  const std::string &  name  )

Define a custom param.

Double2DParamDescriptor * OFX::ParamSetDescriptor::defineDouble2DParam (  const std::string &  name  )

Define a 2D double param.

Double3DParamDescriptor * OFX::ParamSetDescriptor::defineDouble3DParam (  const std::string &  name  )

Define a 3D double param.

DoubleParamDescriptor * OFX::ParamSetDescriptor::defineDoubleParam (  const std::string &  name  )

Define an double param, only callable from describe in context.

GroupParamDescriptor * OFX::ParamSetDescriptor::defineGroupParam (  const std::string &  name  )

Define a group param.

Int2DParamDescriptor * OFX::ParamSetDescriptor::defineInt2DParam (  const std::string &  name  )

Define a 2D integer param.

Int3DParamDescriptor * OFX::ParamSetDescriptor::defineInt3DParam (  const std::string &  name  )

Define a 3D integer param.

IntParamDescriptor * OFX::ParamSetDescriptor::defineIntParam (  const std::string &  name  )

Define an integer param, only callable from describe in context.

PageParamDescriptor * OFX::ParamSetDescriptor::definePageParam (  const std::string &  name  )

Define a Page param.

template<class T> bool OFX::ParamSetDescriptor::defineParamDescriptor (  const std::string &  name, ParamTypeEnum  paramType, T *&  paramPtr )  [inline, protected]

Define a param descriptor of the given type.

PushButtonParamDescriptor * OFX::ParamSetDescriptor::definePushButtonParam (  const std::string &  name  )

Define a push button param.

void OFX::ParamSetDescriptor::defineRawParam (  const std::string &  name, ParamTypeEnum  paramType, OfxPropertySetHandle &  props )  [protected]

calls the raw OFX routine to define a param

RGBAParamDescriptor * OFX::ParamSetDescriptor::defineRGBAParam (  const std::string &  name  )

Define a RGBA param.

RGBParamDescriptor * OFX::ParamSetDescriptor::defineRGBParam (  const std::string &  name  )

Define an RGB param.

StringParamDescriptor * OFX::ParamSetDescriptor::defineStringParam (  const std::string &  name  )

Define a string param.

ParamDescriptor * OFX::ParamSetDescriptor::findPreviouslyDefinedParam (  const std::string &  name  )  [protected]

if a param has been defined in this set, go find it

ParamDescriptor * OFX::ParamSetDescriptor::getParamDescriptor (  const std::string &  name  )  const

tries to fetch a ParamDescriptor, returns 0 if it isn't there

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

void OFX::ParamSetDescriptor::setPageParamOrder (  PageParamDescriptor &  p  )

estabilishes the order of page params. Do it by calling it in turn for each page

void OFX::ParamSetDescriptor::setParamSetHandle (  OfxParamSetHandle  h  )  [protected]

set the param set handle

---

Member Data Documentation

std::map<std::string, ParamDescriptor *> OFX::ParamSetDescriptor::_definedParams [protected]

Set of all previously defined parameters, defined on demand.

OfxParamSetHandle OFX::ParamSetDescriptor::_paramSetHandle [protected]

Parameter set handle.

PropertySet OFX::ParamSetDescriptor::_paramSetProps [protected]

Properties that belong to this param set.

---

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

• ofxsParam.h
• ofxsParams.cpp

---