Cleaning code style of Definitions.

[kdenlive] / src / effectstackedit.h

diff --git a/src/effectstackedit.h b/src/effectstackedit.h
index 1ecf626339b4e3fbb3444cc490a8e08758f7e157..67606b07eb7c17bdbeebd8de70008eb0ccced5a8 100644 (file)
--- a/src/effectstackedit.h
+++ b/src/effectstackedit.h
@@ -21,6 +21,7 @@
 #include "definitions.h"
 #include "timecode.h"
 #include "keyframeedit.h"
+#include "effectstack/parametercontainer.h"
 
 #include <QWidget>
 #include <QDomElement>
@@ -29,61 +30,56 @@
 #include <QMap>
 #include <QScrollArea>
 
-enum WIPE_DIRECTON { UP = 0, DOWN = 1, LEFT = 2, RIGHT = 3, CENTER = 4 };
-
-struct wipeInfo {
-    WIPE_DIRECTON start;
-    WIPE_DIRECTON end;
-    int startTransparency;
-    int endTransparency;
-};
-
-class QFrame;
 class Monitor;
 
 class EffectStackEdit : public QScrollArea
 {
     Q_OBJECT
 public:
-    EffectStackEdit(Monitor *monitor, QWidget *parent = 0);
+    explicit EffectStackEdit(Monitor *monitor, QWidget *parent = 0);
     ~EffectStackEdit();
-    void updateProjectFormat(MltVideoProfile profile, Timecode t);
+    void updateProjectFormat(const MltVideoProfile &profile, const Timecode &t);
     static QMap<QString, QImage> iconCache;
+    /** @brief Sets attribute @param name to @param value.
+    *
+    * Used to disable the effect, by setting disabled="1" */
     void updateParameter(const QString &name, const QString &value);
-    void setFrameSize(QPoint p);
+    void setFrameSize(const QPoint &p);
+    /** @brief Tells the parameters to update their timecode format according to KdenliveSettings. */
     void updateTimecodeFormat();
+    /** @brief Returns true if this effect wants to keep track of current position in clip. */
+    bool effectNeedsSyncPosition() const;
+    Monitor *monitor();
+    /** @brief Install event filter so that scrolling with mouse wheel does not change parameter value. */
+    virtual bool eventFilter( QObject * o, QEvent * e );
+    /** @brief Returns true if this transition requires an on monitor scene. */
+    bool needsMonitorEffectScene() const;
+    /** @brief Set keyframes for this transition. */
+    void setKeyframes(const QString &data, int maximum);
 
 private:
-    void clearAllItems();
-    QVBoxLayout *m_vbox;
-    QList<QWidget*> m_uiItems;
+    EffectMetaInfo m_metaInfo;
     QWidget *m_baseWidget;
-    QDomElement m_params;
-    QMap<QString, QWidget*> m_valueItems;
-    void createSliderItem(const QString& name, int val , int min, int max, const QString);
-    wipeInfo getWipeInfo(QString value);
-    QString getWipeString(wipeInfo info);
-    MltVideoProfile m_profile;
-    Timecode m_timecode;
-    int m_in;
-    int m_out;
-    QPoint m_frameSize;
-    KeyframeEdit *m_keyframeEditor;
-    Monitor *m_monitor;
+    ParameterContainer *m_paramWidget;
 
 public slots:
-    /** \brief Called when an effect is selected, builds the UI for this effect */
-    void transferParamDesc(const QDomElement, int, int , int);
-    void slotSliderMoved(int);
-    /** \brief Called whenever(?) some parameter is changed in the gui.
-     *
-     * Transfers all Dynamic gui parameter settings into m_params(??) */
-    void collectAllParameters();
+    /** @brief Called when an effect is selected, builds the UI for this effect. */
+    void transferParamDesc(const QDomElement &d, ItemInfo info, bool isEffect = true);
+
+    /** @brief Pass position changes of the timeline cursor to the effects to keep their local timelines in sync. */
+    void slotSyncEffectsPos(int pos);
 
 signals:
-    void parameterChanged(const QDomElement, const QDomElement);
+    void parameterChanged(const QDomElement&, const QDomElement&, int);
     void seekTimeline(int);
     void displayMessage(const QString&, int);
+    void checkMonitorPosition(int);
+    void syncEffectsPos(int pos);
+    void showComments(bool show);
+    void effectStateChanged(bool enabled);
+    /** @brief Start an MLT filter job on this clip. */
+    void startFilterJob(const QString &filterName, const QString &filterParams, const QString &consumer, const QString &consumerParams, const QMap <QString, QString>&);
+    void importClipKeyframes(GraphicsRectItem = AVWidget);
 };
 
 #endif