Definition of a widget in an Integra Module interface. More...

#include "api/interface_definition.h"

Public Member Functions
virtual const string &	get_type () const =0
	Get widget type. More...

virtual const string &	get_label () const =0
	Get widget label. More...

virtual const IWidgetPosition &	get_position () const =0
	Get widget position. More...

virtual const string_map &	get_attribute_mappings () const =0
	Get attribute mappings. More...

Detailed Description

Definition of a widget in an Integra Module interface.

Widgets definitions provide hints to users of libIntegra about how user interfaces for integra modules could be laid out. Although most widgets control a single endpoint, they can in some cases control more than one endpoint, for multidimensional widgets.

Member Function Documentation

virtual const string_map& integra_api::IWidgetDefinition::get_attribute_mappings ( ) const

pure virtual

Get attribute mappings.

Example: if a module used an XYScratchPad widget to control a filter's Cutoff and Q endpoints, the attribute mapping would be { 'x' -> 'Cutoff', 'y' -> 'Q' } return a map of widget attribute names to endpoint names

virtual const string& integra_api::IWidgetDefinition::get_label ( ) const

pure virtual

Get widget label.

When the widget is mapped to a single control, the label will match the control's name When the widget is mapped to multiple labels, the label should provide a meaningful name for the set of controls it is mapped to

virtual const IWidgetPosition& integra_api::IWidgetDefinition::get_position ( ) const

pure virtual

Get widget position.

Provides a hint as to how a module's widgets might be laid out

virtual const string& integra_api::IWidgetDefinition::get_type ( ) const

pure virtual

Get widget type.

Widget types are a hint to supporting guis about what sort of widget should be used. The set of supported widget types is defined in SDK\ModuleCreator\src\assets\ModuleCreator_config.xml

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

/Users/jamie/Documents/IntegraLive/libIntegra/api/interface_definition.h

Public Member Functions

Detailed Description

Member Function Documentation