Added support for (Lars Luthman's) GTK GUI extension (SLV2 still does NOT depend on GTK!).

git-svn-id: http://svn.drobilla.net/lad/slv2@546 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 125 insertions, 0 deletions

diff --git a/slv2/pluginguiinstance.h b/slv2/pluginguiinstance.h
new file mode 100644
index 0000000..82628a7
--- /dev/null
+++ b/slv2/pluginguiinstance.h
@@ -0,0 +1,125 @@
+/* SLV2
+ * Copyright (C) 2007 Dave Robillard <http://drobilla.net>
+ *  
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef __SLV2_PLUGINGUIINSTANCE_H__
+#define __SLV2_PLUGINGUIINSTANCE_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <assert.h>
+#include <slv2/lv2-gtk2gui.h>
+#include <slv2/plugin.h>
+
+/** \defgroup lib Plugin GUI library access
+ *
+ * An SLV2GUIInstance is an instantiated GUI for a SLV2Plugin. GUI instances
+ * are loaded from dynamically loaded libraries.  These functions interact 
+ * with the GUI code in the binary library only, they do not read data files
+ * in any way.
+ * 
+ * @{
+ */
+
+
+typedef struct _GUIInstanceImpl* SLV2GUIInstanceImpl;
+
+  
+struct _GtkWidget;
+
+
+/** Instance of a plugin GUI.
+ *
+ * All details are in hidden in the pimpl member to avoid making the
+ * implementation a part of the ABI.
+ */
+typedef struct _GUIInstance {
+	SLV2GUIInstanceImpl      pimpl; ///< Private implementation
+}* SLV2GUIInstance;
+
+
+
+/** Instantiate a plugin GUI.
+ *
+ * The returned object represents shared library objects loaded into memory,
+ * it must be cleaned up with slv2_gui_instance_free when no longer
+ * needed.
+ * 
+ * \a plugin is not modified or directly referenced by the returned object
+ * (instances store only a copy of the plugin's URI).
+ * 
+ * \a host_features NULL-terminated array of features the host supports.
+ * NULL may be passed if the host supports no additional features (unlike
+ * the LV2 specification - SLV2 takes care of it).
+ *
+ * \return NULL if instantiation failed.
+ */
+SLV2GUIInstance
+slv2_plugin_gui_instantiate(SLV2Plugin                 plugin,
+			    SLV2Value                  gui,
+			    LV2UI_Set_Control_Function control_function,
+			    LV2UI_Controller           controller,
+			    const LV2_Host_Feature**   host_features);
+
+
+/** Free a plugin GUI instance.
+ *
+ * \a instance is invalid after this call.
+ */
+void
+slv2_gui_instance_free(SLV2GUIInstance instance);
+
+
+/** Get the GTK+ 2.0 widget for the GUI instance.
+ */
+struct _GtkWidget*
+slv2_gui_instance_get_widget(SLV2GUIInstance instance);
+
+
+/** Get the LV2UI_Descriptor of the plugin GUI instance.
+ *
+ * Normally hosts should not need to access the LV2UI_Descriptor directly,
+ * use the slv2_gui_instance_* functions.
+ *
+ * The returned descriptor is shared and must not be deleted.
+ */
+const LV2UI_Descriptor*
+slv2_gui_instance_get_descriptor(SLV2GUIInstance instance);
+
+
+/** Get the LV2UI_Handle of the plugin GUI instance.
+ *
+ * Normally hosts should not need to access the LV2UI_Handle directly,
+ * use the slv2_gui_instance_* functions.
+ * 
+ * The returned handle is shared and must not be deleted.
+ */
+LV2_Handle
+slv2_gui_instance_get_handle(SLV2GUIInstance instance);
+
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+
+#endif /* __SLV2_PLUGINGUIINSTANCE_H__ */
+