OFX::ParamSet Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::ParamSet:

List of all members.

---

Detailed Description

A set of parameters in a plugin instance.

Public Member Functions
virtual	~ParamSet ()
	dtor
bool	paramExists (const std::string &name) const
void	beginEditBlock (const std::string &name)
	open an undoblock
void	endEditBlock ()
	close an undoblock
Param *	getParam (const std::string &name) const
IntParam *	fetchIntParam (const std::string &name) const
	Fetch an integer param, only callable from describe in context.
Int2DParam *	fetchInt2DParam (const std::string &name) const
	Fetch a 2D integer param.
Int3DParam *	fetchInt3DParam (const std::string &name) const
	Fetch a 3D integer param.
DoubleParam *	fetchDoubleParam (const std::string &name) const
	Fetch an double param, only callable from describe in context.
Double2DParam *	fetchDouble2DParam (const std::string &name) const
	Fetch a 2D double param.
Double3DParam *	fetchDouble3DParam (const std::string &name) const
	Fetch a 3D double param.
StringParam *	fetchStringParam (const std::string &name) const
	Fetch a string param.
RGBAParam *	fetchRGBAParam (const std::string &name) const
	Fetch a RGBA param.
RGBParam *	fetchRGBParam (const std::string &name) const
	Fetch an RGB param.
BooleanParam *	fetchBooleanParam (const std::string &name) const
	Fetch a Boolean param.
ChoiceParam *	fetchChoiceParam (const std::string &name) const
	Fetch a Choice param.
GroupParam *	fetchGroupParam (const std::string &name) const
	Fetch a group param.
PageParam *	fetchPageParam (const std::string &name) const
	Fetch a Page param.
PushButtonParam *	fetchPushButtonParam (const std::string &name) const
	Fetch a push button param.
CustomParam *	fetchCustomParam (const std::string &name) const
	Fetch a custom param.
Protected Member Functions
	mDeclareProtectedAssignAndCC (ParamSet)
ParamTypeEnum	getParamType (const std::string &name) const
	ParamSet (void)
	hidden ctor
void	setParamSetHandle (OfxParamSetHandle h)
	set the param set handle

---

Constructor & Destructor Documentation

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

hidden ctor

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

dtor

---

Member Function Documentation

void OFX::ParamSet::beginEditBlock (  const std::string &  name  )

open an undoblock

void OFX::ParamSet::endEditBlock (   )

close an undoblock

BooleanParam * OFX::ParamSet::fetchBooleanParam (  const std::string &  name  )  const

Fetch a Boolean param.

ChoiceParam * OFX::ParamSet::fetchChoiceParam (  const std::string &  name  )  const

Fetch a Choice param.

CustomParam * OFX::ParamSet::fetchCustomParam (  const std::string &  name  )  const

Fetch a custom param.

Double2DParam * OFX::ParamSet::fetchDouble2DParam (  const std::string &  name  )  const

Fetch a 2D double param.

Double3DParam * OFX::ParamSet::fetchDouble3DParam (  const std::string &  name  )  const

Fetch a 3D double param.

DoubleParam * OFX::ParamSet::fetchDoubleParam (  const std::string &  name  )  const

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

GroupParam * OFX::ParamSet::fetchGroupParam (  const std::string &  name  )  const

Fetch a group param.

Int2DParam * OFX::ParamSet::fetchInt2DParam (  const std::string &  name  )  const

Fetch a 2D integer param.

Int3DParam * OFX::ParamSet::fetchInt3DParam (  const std::string &  name  )  const

Fetch a 3D integer param.

IntParam * OFX::ParamSet::fetchIntParam (  const std::string &  name  )  const

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

PageParam * OFX::ParamSet::fetchPageParam (  const std::string &  name  )  const

Fetch a Page param.

PushButtonParam * OFX::ParamSet::fetchPushButtonParam (  const std::string &  name  )  const

Fetch a push button param.

RGBAParam * OFX::ParamSet::fetchRGBAParam (  const std::string &  name  )  const

Fetch a RGBA param.

RGBParam * OFX::ParamSet::fetchRGBParam (  const std::string &  name  )  const

Fetch an RGB param.

StringParam * OFX::ParamSet::fetchStringParam (  const std::string &  name  )  const

Fetch a string param.

Param * OFX::ParamSet::getParam (  const std::string &  name  )  const

ParamTypeEnum OFX::ParamSet::getParamType (  const std::string &  name  )  const [protected]

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

bool OFX::ParamSet::paramExists (  const std::string &  name  )  const

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

set the param set handle

---

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

• ofxsParam.h
• ofxsParams.cpp

---