Integrate with the required MLT hooks for getting Movit to work.

[kdenlive] / src / beziercurve / beziersplinewidget.h

diff --git a/src/beziercurve/beziersplinewidget.h b/src/beziercurve/beziersplinewidget.h
index 061784488505a08ce1146282ab362e8fb3ba0ee2..c9e48edd5e92609e9f80b82a3bf7a5ca7e1c5ae1 100644 (file)
--- a/src/beziercurve/beziersplinewidget.h
+++ b/src/beziercurve/beziersplinewidget.h
@@ -23,35 +23,64 @@
 #include "beziersplineeditor.h"
 #include "ui_bezierspline_ui.h"
 
-#include <QtCore>
 #include <QWidget>
 
+class DragValue;
+
 class BezierSplineWidget : public QWidget
 {
     Q_OBJECT
     
 public:
-    BezierSplineWidget(const QString &spline, QWidget* parent = 0);
+    /** @brief Sets up the UI and sets the spline to @param spline. */
+    explicit BezierSplineWidget(const QString &spline, QWidget* parent = 0);
+
+    /** @brief Returns the current spline. */
+    QString spline() const;
 
-    QString spline();
+    /** The curvemodes refer to the usage of the spline.
+     * As this widget is currently only used for frei0r.curves the modes are the channels this filter accepts. */
+    enum CurveModes { ModeRed, ModeGreen, ModeBlue, ModeAlpha, ModeLuma, ModeRGB, ModeHue, ModeSaturation };
 
-    enum CurveModes { ModeRed, ModeGreen, ModeBlue, ModeAlpha, ModeLuma, ModeRGB/*, ModeSaturation*/ };
+    /** @brief Sets the mode to @param mode and updates the editors background pixmap if necessary. */
     void setMode(CurveModes mode);
 
 private slots:
-    void slotUpdatePoint(const BPoint &p);
+    /** @brief Sets the spinboxes for modifing the selected point to @param p. */
+    void slotUpdatePointEntries(const BPoint &p);
 
-    void slotUpdatePointP();
-    void slotUpdatePointH1();
-    void slotUpdatePointH2();
+    /** @brief Updates the spline if the current point's p was modified using the spinboxes.
+     * @param value (optional) not used, neccessary to be able to connect to DragValue's valueChanged.
+     * @param final (default = true) emit signal modified? */
+    void slotUpdatePointP(double value = 1, bool final = true);
+    /** @brief Updates the spline if the current point's h1 was modified using the spinboxes.
+     * @param value (optional) not used, neccessary to be able to connect to DragValue's valueChanged.
+     * @param final (default = true) emit signal modified? */
+    void slotUpdatePointH1(double value = 1, bool final = true);
+    /** @brief Updates the spline if the current point's h2 was modified using the spinboxes.
+     * @param value (optional) not used, neccessary to be able to connect to DragValue's valueChanged.
+     * @param final (default = true) emit signal modified? */
+    void slotUpdatePointH2(double value = 1, bool final = true);
 
+    /** @brief Increases the number of lines in the editor's grid. If there are already 8 lines the number is set to 0. */
     void slotGridChange();
+    /** @brief Turns showing the background pixmap in the editor on/off. */
     void slotShowPixmap(bool show = true);
+    /** @brief Resets the current spline. */
     void slotResetSpline();
+    /** @brief Linkes the handles. This will always make them stay in one line through p. */
     void slotSetHandlesLinked(bool linked);
 
+    void slotShowAllHandles(bool show);
+
 private:
     Ui::BezierSpline_UI m_ui;
+    DragValue *m_pX;
+    DragValue *m_pY;
+    DragValue *m_h1X;
+    DragValue *m_h1Y;
+    DragValue *m_h2X;
+    DragValue *m_h2Y;
     BezierSplineEditor m_edit;
     CurveModes m_mode;
     bool m_showPixmap;