Public Member Functions | List of all members
ProcessorEditorBody Class Referenceabstract

A ProcessorEditorBody is an interface class that can be used to create a custom body for a certain processor. More...

Inheritance diagram for ProcessorEditorBody:
ProcessorEditorChildComponent EmptyProcessorEditorBody

Public Member Functions

virtual int getBodyHeight () const =0
 Overwrite this and return the height of the body. More...
 
void refreshBodySize ()
 Call this whenever you want to resize the editor from eg. More...
 
virtual void updateGui ()=0
 Overwrite this and update all gui elements. More...
 
- Public Member Functions inherited from ProcessorEditorChildComponent
ProcessorgetProcessor ()
 Returns a pointer to the processor. More...
 
const ProcessorgetProcessor () const
 Returns a const pointer to the processor. More...
 
 ProcessorEditorChildComponent (ProcessorEditor *editor)
 Creates a new child component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ProcessorEditorChildComponent
const ProcessorEditor * getEditor () const
 Returns a const pointer to the editor if the component is initialized. More...
 
ProcessorEditor * getEditor ()
 Returns a pointer to the editor. More...
 
- Static Protected Member Functions inherited from ProcessorEditorChildComponent
static bool toggleButton (Button *b)
 Small helper function, that toggles a button and returns the new toggle value. More...
 

Detailed Description

A ProcessorEditorBody is an interface class that can be used to create a custom body for a certain processor.

If a ProcessorEditor wants to use a body, it must pass a subclass object of this in its constructor.

Member Function Documentation

virtual int getBodyHeight ( ) const
pure virtual

Overwrite this and return the height of the body.

This value can change, but whenever you change it, call refreshBodySize() to let the editor know.

Implemented in EmptyProcessorEditorBody.

void refreshBodySize ( )
inline

Call this whenever you want to resize the editor from eg.

a button press.

It checks if the Body should be displayed.

virtual void updateGui ( )
pure virtual

Overwrite this and update all gui elements.

This is called asynchronously whenever the processor's setOutputValue() or setAttribute() are called.

Implemented in EmptyProcessorEditorBody.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.