include/ControllerConnection.h

   1 /*
   2  * ControllerConnection.h - declaration of a controller connect, which
   3  *              provides a definition of the link between a controller and
   4  *              model, also handles deferred creation of links while
   5  *              loading project
   6  *
   7  * Copyright (c) 2008 Paul Giblock <pgllama/at/gmail.com>
   8  * Copyright (c) 2010 Tobias Doerffel <tobydox/at/users.sourceforge.net>
   9  *
  10  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public
  14  * License as published by the Free Software Foundation; either
  15  * version 2 of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public
  23  * License along with this program (see COPYING); if not, write to the
  24  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25  * Boston, MA 02110-1301 USA.
  26  *
  27  */
  28
  29
  30 #ifndef _CONTROLLER_CONNECTION_H
  31 #define _CONTROLLER_CONNECTION_H
  32
  33 #include <QtCore/QObject>
  34 #include <QtCore/QVector>
  35
  36 #include "Controller.h"
  37 #include "JournallingObject.h"
  38
  39 class ControllerConnection;
  40
  41 typedef QVector<ControllerConnection *> ControllerConnectionVector;
  42
  43
  44 class EXPORT ControllerConnection : public QObject, public JournallingObject
  45 {
  46         Q_OBJECT
  47 public:
  48
  49         ControllerConnection( Controller * _controller );
  50         ControllerConnection( int _controllerId );
  51
  52         virtual ~ControllerConnection();
  53
  54         inline Controller * getController()
  55         {
  56                 return m_controller;
  57         }
  58
  59         void setController( Controller * _controller );
  60
  61         inline void setController( int _controllerId );
  62
  63         float currentValue( int _offset )
  64         {
  65                 return m_controller->currentValue( _offset );
  66         }
  67
  68         inline void setTargetName( const QString & _name );
  69
  70         inline QString targetName() const
  71         {
  72                 return m_targetName;
  73         }
  74
  75         inline bool isFinalized()
  76         {
  77                 return m_controllerId < 0;
  78         }
  79
  80         static void finalizeConnections();
  81
  82         virtual void saveSettings( QDomDocument & _doc, QDomElement & _this );
  83         virtual void loadSettings( const QDomElement & _this );
  84
  85         static inline const QString classNodeName()
  86         {
  87                 return "connection";
  88         }
  89
  90         virtual QString nodeName() const
  91         {
  92                 return classNodeName();
  93         }
  94
  95
  96 public slots:
  97         void deleteConnection();
  98
  99 protected:
 100         //virtual controllerDialog * createDialog( QWidget * _parent );
 101         Controller * m_controller;
 102         QString m_targetName;
 103         int m_controllerId;
 104
 105         bool m_ownsController;
 106
 107         static ControllerConnectionVector s_connections;
 108
 109 signals:
 110         // The value changed while the mixer isn't running (i.e: MIDI CC)
 111         void valueChanged();
 112
 113         friend class ControllerConnectionDialog;
 114 };
 115
 116 #endif
 117