OFX::Param Class Reference

#include <ofxsParam.h>

Inheritance diagram for OFX::Param:

List of all members.

---

Detailed Description

Base class for all param instances.

Public Member Functions
virtual	~Param ()
	dtor
const std::string &	getName (void) const
	get name
void	setLabels (const std::string &label, const std::string &shortLabel, const std::string &longLabel)
	, set the label properties in a plugin
ParamTypeEnum	getType (void) const
	return the derived type of this parameter
void	setIsSecret (bool v)
	set the secretness of the param, defaults to false
void	setHint (const std::string &hint)
	set the param hint
void	setEnabled (bool v)
	whether the param is enabled
void	getLabels (std::string &label, std::string &shortLabel, std::string &longLabel) const
	fetch the labels
bool	getIsSecret (void) const
	get whether the param is secret
bool	getIsEnable (void) const
	whether the param is enabled
std::string	getHint (void) const
	get the param hint
std::string	getScriptName (void) const
	get the script name
GroupParam *	getParent (void) const
	get the group param that is the parent of this one
Protected Member Functions
Param &	operator= (const Param &v1)
	Param (const Param &v)
	Param (void)
	Param (const ParamSet *paramSet, const std::string &name, ParamTypeEnum type, OfxParamHandle handle)
	Base class for all param instances.
Protected Attributes
std::string	_paramName
ParamTypeEnum	_paramType
PropertySet	_paramProps
OfxParamHandle	_paramHandle
const ParamSet *	_paramSet
Friends
class	ParamSet

---

Constructor & Destructor Documentation

OFX::Param::Param (  const Param &  v  )  [inline, protected]

OFX::Param::Param (  void   )  [inline, protected]

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

Base class for all param instances.

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

dtor

---

Member Function Documentation

std::string OFX::Param::getHint (  void   )  const

get the param hint

bool OFX::Param::getIsEnable (  void   )  const

whether the param is enabled

bool OFX::Param::getIsSecret (  void   )  const

get whether the param is secret

void OFX::Param::getLabels (  std::string &  label, std::string &  shortLabel, std::string &  longLabel )  const

fetch the labels

const std::string & OFX::Param::getName (  void   )  const

get name

GroupParam * OFX::Param::getParent (  void   )  const

get the group param that is the parent of this one

std::string OFX::Param::getScriptName (  void   )  const

get the script name

ParamTypeEnum OFX::Param::getType (  void   )  const [inline]

return the derived type of this parameter

Param& OFX::Param::operator= (  const Param &  v1  )  [inline, protected]

void OFX::Param::setEnabled (  bool  v  )

whether the param is enabled

void OFX::Param::setHint (  const std::string &  v  )

set the param hint

void OFX::Param::setIsSecret (  bool  v  )

set the secretness of the param, defaults to false

void OFX::Param::setLabels (  const std::string &  label, const std::string &  shortLabel, const std::string &  longLabel )

, set the label properties in a plugin

---

Friends And Related Function Documentation

friend class ParamSet [friend]

Reimplemented in OFX::ValueParam, OFX::IntParam, OFX::Int2DParam, OFX::Int3DParam, OFX::BaseDoubleParam, OFX::DoubleParam, OFX::Double2DParam, OFX::Double3DParam, OFX::RGBParam, OFX::RGBAParam, OFX::StringParam, OFX::ChoiceParam, OFX::BooleanParam, OFX::GroupParam, OFX::PageParam, OFX::CustomParam, and OFX::PushButtonParam.

---

Member Data Documentation

OfxParamHandle OFX::Param::_paramHandle [protected]

std::string OFX::Param::_paramName [protected]

PropertySet OFX::Param::_paramProps [protected]

const ParamSet* OFX::Param::_paramSet [protected]

ParamTypeEnum OFX::Param::_paramType [protected]

---

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

• ofxsParam.h
• ofxsParams.cpp

---