calf_plugins::main_window_iface Struct Reference

Interface used by the plugin to communicate with the main hosting window. More...

#include <gui.h>

Inheritance diagram for calf_plugins::main_window_iface:

Public Member Functions
virtual void	set_owner (main_window_owner_iface *owner)=0
	Set owner pointer.
virtual void	add_condition (const std::string &name)=0
	Add a condition to the list of conditions supported by the host.
virtual void	create ()=0
	Create the actual window associated with this interface.
virtual void	create_status_icon ()=0
	Create the actual window associated with this interface.
virtual void	add_plugin (jack_host *plugin)=0
	Add the plugin to the window.
virtual void	del_plugin (plugin_ctl_iface *plugin)=0
	Remove the plugin from the window.
virtual void	rename_plugin (plugin_ctl_iface *plugin, std::string name)=0
virtual void	refresh_plugin (plugin_ctl_iface *plugin)=0
	Refresh the plugin UI.
virtual void	refresh_plugin_param (plugin_ctl_iface *plugin, int param_no)=0
	Refresh the plugin UI.
virtual void	set_window (plugin_ctl_iface *plugin, plugin_gui_window *window)=0
	Bind the plugin window to the plugin.
virtual void	refresh_all_presets (bool builtin_too)=0
	Refresh preset lists on all windows (if, for example, a new preset has been created).
virtual void	open_file ()=0
	Default open file operation.
virtual bool	save_file ()=0
	Default save file operation.
virtual void	on_closed ()=0
	Called to clean up when host quits.
virtual void	show_error (const std::string &text)=0
	Show an error message.
virtual	~main_window_iface ()
Public Member Functions inherited from calf_plugins::progress_report_iface
virtual void	report_progress (float percentage, const std::string &message)=0
virtual	~progress_report_iface ()

Detailed Description

Interface used by the plugin to communicate with the main hosting window.

Constructor & Destructor Documentation

~main_window_iface()

virtual calf_plugins::main_window_iface::~main_window_iface ( )

inlinevirtual

Member Function Documentation

add_condition()

virtual void calf_plugins::main_window_iface::add_condition ( const std::string & name )

pure virtual

Add a condition to the list of conditions supported by the host.

Implemented in calf_plugins::gtk_main_window.

add_plugin()

virtual void calf_plugins::main_window_iface::add_plugin ( jack_host * plugin )

pure virtual

Add the plugin to the window.

Implemented in calf_plugins::gtk_main_window.

create()

virtual void calf_plugins::main_window_iface::create ( )

pure virtual

Create the actual window associated with this interface.

Implemented in calf_plugins::gtk_main_window.

create_status_icon()

virtual void calf_plugins::main_window_iface::create_status_icon ( )

pure virtual

Create the actual window associated with this interface.

Implemented in calf_plugins::gtk_main_window.

del_plugin()

virtual void calf_plugins::main_window_iface::del_plugin ( plugin_ctl_iface * plugin )

pure virtual

Remove the plugin from the window.

Implemented in calf_plugins::gtk_main_window.

on_closed()

virtual void calf_plugins::main_window_iface::on_closed ( )

pure virtual

Called to clean up when host quits.

Implemented in calf_plugins::gtk_main_window.

open_file()

virtual void calf_plugins::main_window_iface::open_file ( )

pure virtual

Default open file operation.

Implemented in calf_plugins::gtk_main_window.

refresh_all_presets()

virtual void calf_plugins::main_window_iface::refresh_all_presets ( bool builtin_too )

pure virtual

Refresh preset lists on all windows (if, for example, a new preset has been created).

Implemented in calf_plugins::gtk_main_window.

refresh_plugin()

virtual void calf_plugins::main_window_iface::refresh_plugin ( plugin_ctl_iface * plugin )

pure virtual

Refresh the plugin UI.

Implemented in calf_plugins::gtk_main_window.

refresh_plugin_param()

virtual void calf_plugins::main_window_iface::refresh_plugin_param ( plugin_ctl_iface * plugin, int param_no )

pure virtual

Refresh the plugin UI.

Implemented in calf_plugins::gtk_main_window.

rename_plugin()

virtual void calf_plugins::main_window_iface::rename_plugin ( plugin_ctl_iface * plugin, std::string name )

pure virtual

Implemented in calf_plugins::gtk_main_window.

save_file()

virtual bool calf_plugins::main_window_iface::save_file ( )

pure virtual

Default save file operation.

Implemented in calf_plugins::gtk_main_window.

set_owner()

virtual void calf_plugins::main_window_iface::set_owner ( main_window_owner_iface * owner )

pure virtual

Set owner pointer.

Implemented in calf_plugins::gtk_main_window.

set_window()

virtual void calf_plugins::main_window_iface::set_window ( plugin_ctl_iface * plugin, plugin_gui_window * window )

pure virtual

Bind the plugin window to the plugin.

Implemented in calf_plugins::gtk_main_window.

show_error()

virtual void calf_plugins::main_window_iface::show_error ( const std::string & text )

pure virtual

Show an error message.

Implemented in calf_plugins::gtk_main_window.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/gui.h