#include <Control.h>

Inheritance diagram for Control:

Public Member Functions
	Control (Control *parent, string id)
string	getXMLRepresentation ()
void	restoreFromXML (string xml)
void	registerControlUser (ControlUser *user)
virtual string	getStringRepresentation ()=0

Constructor & Destructor Documentation

◆ Control()

Control::Control	(	Control *	parent,
		string	id )

The parent is the logical owner of this control. Parent should only be null for the root node. The id is a string uniquely identifying this control within the context of the parent control. No spaces or dots are allowed in this id. Children id's are denoted by <parent-id>.<children-id>, so that one can refer to any control in the hierarchy by separating them with dots. Example: Main.AddSynth.FrequencyLFO.Amplitude

Member Function Documentation

◆ getStringRepresentation()

virtual string Control::getStringRepresentation ( )

pure virtual

This should return a string representation of the controls internal value

Implemented in FloatControl.

◆ getXMLRepresentation()

string Control::getXMLRepresentation ( )

Will recursively get the XML representation for all the subcontrols. Used for saving to file and copy-pasting settings

◆ registerControlUser()

void Control::registerControlUser ( ControlUser * user )

Register a controluser. This will cause this user to be notified whenever the contents of the control changes.

◆ restoreFromXML()

void Control::restoreFromXML ( string xml )

Set the value of this (and possibly subcomponents as well) based on a xml description.

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

/home/runner/work/lmms-fork/lmms-fork/plugins/ZynAddSubFx/zynaddsubfx/src/Misc/Control.h