Zrythm v2.0.0-DEV
a highly automated and intuitive digital audio workstation
Loading...
Searching...
No Matches
zrythm::plugins::IPluginHostWindow Class Referenceabstract

Interface for top-level plugin hosting windows. More...

#include <src/plugins/iplugin_host_window.h>

Inheritance diagram for zrythm::plugins::IPluginHostWindow:

Public Member Functions

virtual void setJuceComponentContentNonOwned (juce::Component *content_non_owned)=0
 Sets the JUCE component (normally a juce editor component) as the child of this window.
virtual void setSizeAndCenter (int width, int height)=0
 Sets the window size and centers it on the screen.
virtual void setSize (int width, int height)=0
 Set the window size without centering.
virtual void setVisible (bool shouldBeVisible)=0
virtual WId getEmbedWindowId () const =0
 Gets a native window handle to embed in.

Detailed Description

Interface for top-level plugin hosting windows.

Definition at line 15 of file iplugin_host_window.h.

Member Function Documentation

◆ getEmbedWindowId()

virtual WId zrythm::plugins::IPluginHostWindow::getEmbedWindowId ( ) const
pure virtual

Gets a native window handle to embed in.

To be used in natively hosted plugins.

Implemented in zrythm::plugins::JuceDocumentPluginHostWindow.

◆ setJuceComponentContentNonOwned()

virtual void zrythm::plugins::IPluginHostWindow::setJuceComponentContentNonOwned ( juce::Component * content_non_owned)
pure virtual

Sets the JUCE component (normally a juce editor component) as the child of this window.

To be used by JUCE-hosted plugins.

Implemented in zrythm::plugins::JuceDocumentPluginHostWindow.

◆ setSize()

virtual void zrythm::plugins::IPluginHostWindow::setSize ( int width,
int height )
pure virtual

Set the window size without centering.

Used for resizes.

Implemented in zrythm::plugins::JuceDocumentPluginHostWindow.

◆ setSizeAndCenter()

virtual void zrythm::plugins::IPluginHostWindow::setSizeAndCenter ( int width,
int height )
pure virtual

Sets the window size and centers it on the screen.

Note
This is not needed when using setJuceComponentContentNonOwned.

Implemented in zrythm::plugins::JuceDocumentPluginHostWindow.


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