Ingen::Client::PluginUI Class Reference

Custom user interface for a plugin. More...

#include <PluginUI.hpp>

Public Member Functions
bool	instantiate ()
	Instantiate the UI. More...
bool	instantiated ()
SuilWidget	get_widget ()
void	port_event (uint32_t port_index, uint32_t buffer_size, uint32_t format, const void *buffer)
bool	is_resizable () const
	INGEN_SIGNAL (property_changed, void, const Raul::URI &, const Raul::URI &, const Atom &)
	Signal emitted when the UI sets a property. More...
Ingen::World *	world () const
SPtr< const BlockModel >	block () const

Static Public Member Functions
static SPtr< PluginUI >	create (Ingen::World *world, SPtr< const BlockModel > block, const LilvPlugin *plugin)
	Create a UI for the given block and plugin. More...

Detailed Description

Custom user interface for a plugin.

Member Function Documentation

create()

SPtr< PluginUI > Ingen::Client::PluginUI::create ( Ingen::World *  world, SPtr< const BlockModel >  block, const LilvPlugin *  plugin  )

static

Create a UI for the given block and plugin.

This does not actually instantiate the UI itself, so signals can be connected first. The caller should connect to signal_property_changed, then call instantiate().

Referenced by Ingen::Client::PluginModel::get_property().

instantiate()

bool Ingen::Client::PluginUI::instantiate

(

)

Instantiate the UI.

If true is returned, instantiation was successfull and the widget can be obtained with get_widget(). Otherwise, instantiation failed, so there is no widget and the UI can not be used.

INGEN_SIGNAL()

Ingen::Client::PluginUI::INGEN_SIGNAL	(	property_changed	,
		void	,
		const Raul::URI &	,
		const Raul::URI &	,
		const Atom &
	)

Signal emitted when the UI sets a property.

The application must connect to this signal to communicate with the engine and/or update itself as necessary.

---

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

• PluginUI.hpp
• PluginUI.cpp