| suil.h | suil.h | |||
|---|---|---|---|---|
| skipping to change at line 78 | skipping to change at line 78 | |||
| This contains the various functions that a plugin UI may use to communic ate | This contains the various functions that a plugin UI may use to communic ate | |||
| with the plugin. It is passed to @ref suil_instance_new to provide | with the plugin. It is passed to @ref suil_instance_new to provide | |||
| these functions to the UI. | these functions to the UI. | |||
| */ | */ | |||
| typedef struct SuilHostImpl SuilHost; | typedef struct SuilHostImpl SuilHost; | |||
| /** An instance of an LV2 plugin UI. */ | /** An instance of an LV2 plugin UI. */ | |||
| typedef struct SuilInstanceImpl SuilInstance; | typedef struct SuilInstanceImpl SuilInstance; | |||
| /** Opaque pointer to a UI handle. */ | ||||
| typedef void* SuilHandle; | ||||
| /** Opaque pointer to a UI widget. */ | /** Opaque pointer to a UI widget. */ | |||
| typedef void* SuilWidget; | typedef void* SuilWidget; | |||
| /** | /** | |||
| UI controller. | UI controller. | |||
| This is an opaque pointer passed by the user which is passed to the vari ous | This is an opaque pointer passed by the user which is passed to the vari ous | |||
| UI control functions (e.g. SuilPortWriteFunc). It is typically used to pass | UI control functions (e.g. SuilPortWriteFunc). It is typically used to pass | |||
| a pointer to some controller object the host uses to communicate with | a pointer to some controller object the host uses to communicate with | |||
| plugins. | plugins. | |||
| skipping to change at line 216 | skipping to change at line 219 | |||
| Free a plugin UI instance. | Free a plugin UI instance. | |||
| The caller must ensure all references to the UI have been dropped before | The caller must ensure all references to the UI have been dropped before | |||
| calling this function (e.g. it has been removed from its parent). | calling this function (e.g. it has been removed from its parent). | |||
| */ | */ | |||
| SUIL_API | SUIL_API | |||
| void | void | |||
| suil_instance_free(SuilInstance* instance); | suil_instance_free(SuilInstance* instance); | |||
| /** | /** | |||
| Get the handle for a UI instance. | ||||
| Returns the handle to the UI instance. The returned handle has opaque t | ||||
| ype | ||||
| to insulate the Suil API from LV2 extensions, but in pactice it is curre | ||||
| ntly | ||||
| of type @ref LV2UI_Handle. This should not normally be needed. | ||||
| The returned handle is shared and must not be deleted. | ||||
| */ | ||||
| SUIL_API | ||||
| SuilHandle | ||||
| suil_instance_get_handle(SuilInstance* instance); | ||||
| /** | ||||
| Get the widget for a UI instance. | Get the widget for a UI instance. | |||
| Returns an opaque pointer to a widget, the type of which matches the @c | Returns an opaque pointer to a widget, the type of which matches the @c | |||
| container_type_uri parameter of @ref suil_instance_new. Note this may b e a | container_type_uri parameter of @ref suil_instance_new. Note this may b e a | |||
| wrapper widget created by Suil, and not necessarily the widget directly | wrapper widget created by Suil, and not necessarily the widget directly | |||
| implemented by the UI. | implemented by the UI. | |||
| */ | */ | |||
| SUIL_API | SUIL_API | |||
| SuilWidget | SuilWidget | |||
| suil_instance_get_widget(SuilInstance* instance); | suil_instance_get_widget(SuilInstance* instance); | |||
| End of changes. 2 change blocks. | ||||
| 0 lines changed or deleted | 18 lines changed or added | |||