2 Copyright (C) 2012 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /* -*- Mode: C ; c-basic-offset: 2 -*- */
21 /*****************************************************************************
23 * This work is in public domain.
25 * This file is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
29 * If you have questions, contact Nedko Arnaudov <nedko@arnaudov.name> or
30 * ask in #lad channel, FreeNode IRC network.
32 *****************************************************************************/
34 #ifndef LV2_EXTERNAL_UI_H__5AFE09A5_0FB7_47AF_924E_2AF0F8DE8873__INCLUDED
35 #define LV2_EXTERNAL_UI_H__5AFE09A5_0FB7_47AF_924E_2AF0F8DE8873__INCLUDED
37 /** UI extension suitable for out-of-process UIs */
38 #define LV2_EXTERNAL_UI_URI "http://lv2plug.in/ns/extensions/ui#external"
40 #define LV2_EXTERNAL_UI_KX__Host "http://kxstudio.sf.net/ns/lv2ext/external-ui#Host"
46 } /* Adjust editor indent */
50 * When LV2_EXTERNAL_UI_URI UI is instantiated, the returned
51 * LV2UI_Widget handle must be cast to pointer to struct lv2_external_ui.
52 * UI is created in invisible state.
54 struct lv2_external_ui
57 * Host calls this function regulary. UI library implementing the
58 * callback may do IPC or redraw the UI.
60 * @param _this_ the UI context
62 void (* run)(struct lv2_external_ui * _this_);
65 * Host calls this function to make the plugin UI visible.
67 * @param _this_ the UI context
69 void (* show)(struct lv2_external_ui * _this_);
72 * Host calls this function to make the plugin UI invisible again.
74 * @param _this_ the UI context
76 void (* hide)(struct lv2_external_ui * _this_);
79 #define LV2_EXTERNAL_UI_RUN(ptr) (ptr)->run(ptr)
80 #define LV2_EXTERNAL_UI_SHOW(ptr) (ptr)->show(ptr)
81 #define LV2_EXTERNAL_UI_HIDE(ptr) (ptr)->hide(ptr)
84 * On UI instantiation, host must supply LV2_EXTERNAL_UI_URI
85 * feature. LV2_Feature::data must be pointer to struct lv2_external_ui_host. */
86 struct lv2_external_ui_host
89 * Callback that plugin UI will call
90 * when UI (GUI window) is closed by user.
91 * This callback wil; be called during execution of lv2_external_ui::run()
92 * (i.e. not from background thread).
94 * After this callback is called, UI is defunct. Host must call
95 * LV2UI_Descriptor::cleanup(). If host wants to make the UI visible
96 * again UI must be reinstantiated.
98 * @param controller Host context associated with plugin UI, as
99 * supplied to LV2UI_Descriptor::instantiate()
101 void (* ui_closed)(void* controller);
104 * Optional (may be NULL) "user friendly" identifier which the UI
105 * may display to allow a user to easily associate this particular
106 * UI instance with the correct plugin instance as it is represented
107 * by the host (e.g. "track 1" or "channel 4").
109 * If supplied by host, the string will be referenced only during
110 * LV2UI_Descriptor::instantiate()
112 const char * plugin_human_id;
116 { /* Adjust editor indent */
122 #endif /* #ifndef LV2_EXTERNAL_UI_H__5AFE09A5_0FB7_47AF_924E_2AF0F8DE8873__INCLUDED */