UI Class Reference

Minimum implementation of UI parameters. We only support the setting and getting of values. More...

#include <AudioFaustDSP.h>

Collaboration diagram for UI:

Public Member Functions
virtual void	addButton (const char *label, float *zone)
virtual void	addCheckButton (const char *label, float *zone)
virtual void	addHorizontalBargraph (const char *label, float *zone, float min, float max)
virtual void	addHorizontalSlider (const char *label, float *zone, float init, float min, float max, float step)
virtual void	addNumEntry (const char *label, float *zone, float init, float min, float max, float step)
virtual void	addSoundfile (const char *label, const char *filename, Soundfile **sf_zone)
virtual void	addVerticalBargraph (const char *label, float *zone, float min, float max)
virtual void	addVerticalSlider (const char *label, float *zone, float init, float min, float max, float step)
virtual void	closeBox ()
virtual void	declare (float *zone, const char *key, const char *val)
virtual bool	exists (const char *label)
	checks if a label exists
virtual float	getValue (const char *label)
const char *	label (int idx)
	Returns the label at the indicated position. nullptr is returned if the index is too big.
virtual void	openHorizontalBox (const char *label)
virtual void	openTabBox (const char *label)
virtual void	openVerticalBox (const char *label)
virtual bool	setValue (const char *label, float value)
virtual size_t	size ()
	Returns the number of label entries.

Protected Member Functions
void	addEntry (const char *label, float *zone, bool withLimits=false, float min=0, float max=0)
Entry *	findEntry (const char *name)

Protected Attributes
audio_tools::Vector< Entry >	entries

Detailed Description

Minimum implementation of UI parameters. We only support the setting and getting of values.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

addButton()

virtual void addButton ( const char *  label, float *  zone  )

inlinevirtual

addCheckButton()

virtual void addCheckButton ( const char *  label, float *  zone  )

inlinevirtual

addEntry()

void addEntry ( const char *  label, float *  zone, bool  withLimits = false, float  min = 0, float  max = 0  )

inlineprotected

addHorizontalBargraph()

virtual void addHorizontalBargraph ( const char *  label, float *  zone, float  min, float  max  )

inlinevirtual

addHorizontalSlider()

virtual void addHorizontalSlider ( const char *  label, float *  zone, float  init, float  min, float  max, float  step  )

inlinevirtual

addNumEntry()

virtual void addNumEntry ( const char *  label, float *  zone, float  init, float  min, float  max, float  step  )

inlinevirtual

addSoundfile()

virtual void addSoundfile ( const char *  label, const char *  filename, Soundfile **  sf_zone  )

inlinevirtual

addVerticalBargraph()

virtual void addVerticalBargraph ( const char *  label, float *  zone, float  min, float  max  )

inlinevirtual

addVerticalSlider()

virtual void addVerticalSlider ( const char *  label, float *  zone, float  init, float  min, float  max, float  step  )

inlinevirtual

closeBox()

virtual void closeBox ( )

inlinevirtual

declare()

virtual void declare ( float *  zone, const char *  key, const char *  val  )

inlinevirtual

exists()

virtual bool exists ( const char *  label )

inlinevirtual

checks if a label exists

findEntry()

Entry * findEntry ( const char *  name )

inlineprotected

getValue()

virtual float getValue ( const char *  label )

inlinevirtual

label()

const char * label ( int  idx )

inline

Returns the label at the indicated position. nullptr is returned if the index is too big.

openHorizontalBox()

virtual void openHorizontalBox ( const char *  label )

inlinevirtual

openTabBox()

virtual void openTabBox ( const char *  label )

inlinevirtual

openVerticalBox()

virtual void openVerticalBox ( const char *  label )

inlinevirtual

setValue()

virtual bool setValue ( const char *  label, float  value  )

inlinevirtual

size()

virtual size_t size ( )

inlinevirtual

Returns the number of label entries.

Member Data Documentation

entries

audio_tools::Vector<Entry> entries

protected

---

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

• src/AudioTools/AudioLibs/AudioFaustDSP.h