Detailed Description

A description for a parameter to be used in a meta-data, and its UI in an eventual rollout.

There are reasonable defaults for most of the fields. The ones that have to be filled are:

m_name: the name of the parameter. It cannot contain single quotes. All non-alphanumerical characters will be replaced with underscores, but the control label will show them.
m_dataType: for now, supported types are limited to TYPE_STRING, TYPE_FLOAT, TYPE_BOOL and TYPE_INT
m_ctrlType: should be appropriate for m_dataType. Supported types are limited to TYPE_EDITBOX, TYPE_SPINNER, TYPE_SINGLECHEKBOX, TYPE_CHECKBUTTON and TYPE_SLIDER
m_ctrlLabel: the label for the corresponding label. If not defined, m_name will be used
m_defValue: a default value for the parameter

#include <IMetaData.h>

Public Member Functions
	ParamDescriptor ()
Public Attributes
MCHAR *	m_name
ParamType2	m_dataType
PB2Value	m_defValue
ULONGLONG	m_flags
PB2Value	m_rangeLow
PB2Value	m_rangeHigh
ControlType2	m_ctrlType
MCHAR *	m_ctrlLabel
int	m_width
int	m_height
IPoint2	m_offset
ControlAlign	m_ctrlAlign
bool	m_sliderHorizontal
int	m_sliderTicks
bool	m_labelOnTop
Color	m_highlightColor

Constructor & Destructor Documentation

ParamDescriptor ( ) [inline]

                         :
            m_name(NULL),
            m_ctrlLabel(NULL),
            m_dataType(TYPE_STRING),
            m_ctrlType(TYPE_EDITBOX),
            m_width(-1),
            m_height(-1),
            m_offset(0, 0),
            m_ctrlAlign(eAlignCenter),
            m_sliderHorizontal(true),
            m_sliderTicks(0),
            m_labelOnTop(false),
            m_highlightColor(0.99f, 0.86f, 0.03f)
        {
        }