1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-plugin-fw
* Created on: 24 нояб. 2020 г.
*
* lsp-plugin-fw is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-plugin-fw 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-plugin-fw. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_PLUG_FW_UI_MODULE_H_
#define LSP_PLUG_IN_PLUG_FW_UI_MODULE_H_
#ifndef LSP_PLUG_IN_PLUG_FW_UI_IMPL_H_
#error "Use #include <lsp-plug.in/plug-fw/ui/ui.h>"
#endif /* LSP_PLUG_IN_PLUG_FW_UI_IMPL_H_ */
#include <lsp-plug.in/plug-fw/version.h>
#include <lsp-plug.in/plug-fw/plug.h>
#include <lsp-plug.in/plug-fw/core/KVTStorage.h>
#include <lsp-plug.in/plug-fw/ui/IWrapper.h>
#include <lsp-plug.in/tk/tk.h>
namespace lsp
{
namespace ui
{
class IWrapper;
/**
* UI Module
*/
class Module
{
private:
Module &operator = (const Module &);
protected:
const meta::plugin_t *pMetadata;
IWrapper *pWrapper;
tk::Display *pDisplay; // Display object
tk::Widget *wRoot; // Root widget (window)
protected:
void do_destroy();
public:
explicit Module(const meta::plugin_t *meta);
virtual ~Module();
/** Initialize UI
*
* @param wrapper plugin wrapper
* @param dpy display object
* @return status of operation
*/
virtual status_t init(IWrapper *wrapper, tk::Display *dpy);
/**
* Destroy the UI
*/
virtual void destroy();
/**
* Method is called after all UI initialization has been completed
* @param window the actual main window of the plugin
* @return status of operation
*/
virtual status_t post_init();
/**
* Method is called before the UI destruction is performed
* @return status of operation
*/
virtual status_t pre_destroy();
/**
* Method is called when the plugin wrapper triggers the plugin reset event.
* This method can apply additional plugin state updates, for example, change
* the contents of the KVT storage.
* @return status of operation
*/
virtual status_t reset_settings();
/**
* This method is called on each UI iteration.
*/
virtual void idle();
/**
* Triggers when any KVT parameter change occurs
* @param kvt KVT storage
* @param id KVT parameter identifier
* @param value KVT parameter value
*/
virtual void kvt_changed(core::KVTStorage *kvt, const char *id, const core::kvt_param_t *value);
public:
inline const meta::plugin_t *metadata() const { return pMetadata; }
inline IWrapper *wrapper() { return pWrapper; }
inline tk::Display *display() { return pDisplay; }
inline tk::Widget *root() { return wRoot; }
inline void set_root(tk::Widget *root) { wRoot = root; }
public:
/** Method executed when the time position of plugin was updated
*
*/
void position_updated(const plug::position_t *pos);
};
}
}
#endif /* LSP_PLUG_IN_PLUG_FW_UI_MODULE_H_ */
|