Lv2ViewBase.h

Go to the documentation of this file.

/*
 * Lv2ViewBase.h - base class for Lv2 plugin views
 *
 * Copyright (c) 2018-2023 Johannes Lorenz <jlsf2013$users.sourceforge.net, $=@>
 *
 * This file is part of LMMS - https://lmms.io
 *
 * This program 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 program 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 (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 */
 
#ifndef LMMS_GUI_LV2_VIEW_BASE_H
#define LMMS_GUI_LV2_VIEW_BASE_H
 
#include "lmmsconfig.h"
 
#ifdef LMMS_HAVE_LV2
 
 
#include "LinkedModelGroupViews.h"
#include "lmms_export.h"
#include "Lv2Basics.h"
 
 
class QPushButton;
class QMdiSubWindow;
namespace lmms
{
 
 
class Lv2Proc;
class Lv2ControlBase;
 
 
namespace gui
{
 

class Lv2ViewProc : public LinkedModelGroupView
{
public:
        Lv2ViewProc(QWidget *parent, Lv2Proc *proc, int colNum);
        ~Lv2ViewProc() override = default;
 
private:
        static AutoLilvNode uri(const char *uriStr);
};
 
 
 
 
class HelpWindowEventFilter : public QObject
{
        Q_OBJECT
        class Lv2ViewBase* const m_viewBase;
protected:
        bool eventFilter(QObject* obj, QEvent* event) override;
public:
        HelpWindowEventFilter(class Lv2ViewBase* viewBase);
};
 
 
 

class LMMS_EXPORT Lv2ViewBase : public LinkedModelGroupsView
{
        friend class HelpWindowEventFilter;
protected:
        Lv2ViewBase(class QWidget *pluginWidget, Lv2ControlBase *ctrlBase);
        ~Lv2ViewBase();
 
        // these widgets must be connected by child widgets
        QPushButton* m_reloadPluginButton = nullptr;
        QPushButton* m_toggleUIButton = nullptr;
        QPushButton* m_helpButton = nullptr;
 
        void toggleUI();
        void toggleHelp(bool visible);
        void closeHelpWindow();
 
        // to be called by child virtuals
        void modelChanged(Lv2ControlBase* ctrlBase);
 
private:
        enum Rows
        {
                ButtonRow,
                ProcRow,
                LinkChannelsRow
        };
 
        static AutoLilvNode uri(const char *uriStr);
        LinkedModelGroupView* getGroupView() override { return m_procView; }
        void onHelpWindowClosed();
 
        Lv2ViewProc* m_procView;

        const int m_colNum = 6;
        QMdiSubWindow* m_helpWindow = nullptr;
        HelpWindowEventFilter m_helpWindowEventFilter;
};
 
 
} // namespace gui
 
} // namespace lmms
 
#endif // LMMS_HAVE_LV2
 
#endif // LMMS_GUI_LV2_VIEW_BASE_H