Cleaning code style of Definitions.

[kdenlive] / src / transition.h

diff --git a/src/transition.h b/src/transition.h
index 0c75f6ef8f1da4e5df81624a164affbf92e56a5f..4f9378181eb6ed91dc74045b7b7221187c85324b 100644 (file)
--- a/src/transition.h
+++ b/src/transition.h
@@ -15,6 +15,12 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+ * @class Transition
+ * @author Jean-Baptiste Mardelle
+ * @brief Describes a transition with a name, parameters, keyframes, etc.
+ */
+
 #ifndef TRANSITION_H
 #define TRANSITION_H
 
@@ -28,11 +34,6 @@
 #include "definitions.h"
 #include "abstractclipitem.h"
 
-
-/**Describes a Transition, with a name, parameters keyframes, etc.
-  *@author Jean-Baptiste Mardelle
-  */
-
 class ClipItem;
 
 class Transition : public AbstractClipItem
@@ -40,64 +41,63 @@ class Transition : public AbstractClipItem
     Q_OBJECT
 public:
 
-    Transition(const ItemInfo info, int transitiontrack, double fps, QDomElement params = QDomElement(), bool automaticTransition = false);
+    Transition(const ItemInfo &info, int transitiontrack, double fps, const QDomElement &params = QDomElement(), bool automaticTransition = false);
     virtual ~Transition();
     virtual void paint(QPainter *painter,
                        const QStyleOptionGraphicsItem *option,
                        QWidget *widget);
     virtual int type() const;
-    /** Returns an XML representation of this transition. */
+
+    /** @brief Returns an XML representation of this transition. */
     QDomElement toXML();
 
-    /** Return the track number of transition in the playlist*/
+    /** @brief Returns the track number of the transition in the playlist. */
     int transitionEndTrack() const;
-    bool hasClip(const ClipItem * clip) const;
-    bool belongsToClip(const ClipItem * clip) const;
-    bool invertedTransition() const;
-    QString transitionName() const;
     QString transitionTag() const;
-    OPERATIONTYPE operationMode(QPointF pos);
+    QStringList transitionInfo() const;
+    OperationType operationMode(const QPointF &pos);
+    static int itemHeight();
+    static int itemOffset();
     //const QMap < QString, QString > transitionParameters() const;
-    void setTransitionParameters(const QDomElement params);
-    void setTransitionDirection(bool inv);
+    void setTransitionParameters(const QDomElement &params);
     void setTransitionTrack(int track);
-    QPixmap transitionPixmap() const;
-    //Transition *reparent(ClipItem * clip);
-    bool isValid() const;
-    /** Transition should be linked to another track */
+
+    /** @brief Links the transition to another track.
+     *
+     * This happens only if the current track is not forced. */
     void updateTransitionEndTrack(int newtrack);
     void setForcedTrack(bool force, int track);
     bool forcedTrack() const;
-    const ClipItem *referencedClip() const;
     Transition *clone();
     bool isAutomatic() const;
     void setAutomatic(bool automatic);
     bool hasGeometry();
+    int defaultZValue() const;
+    /** @brief When a transition is resized, check if keyframes are out of the transition and fix if necessary. 
+     * @param oldEnd the previous transition end, so that when we expand the transition, if there is a keyframe at end we move it
+     */
+    bool updateKeyframes(int oldEnd);
 
 protected:
     virtual QVariant itemChange(GraphicsItemChange change, const QVariant &value);
 
 private:
-    bool m_singleClip;
     QString m_name;
     bool m_forceTransitionTrack;
 
-    /** true if the transition was added automatically and should be moved with its clip */
+    /** @brief True if the transition is attached to its clip. */
     bool m_automaticTransition;
-    /** contains the transition parameters */
+
+    /** @brief Contains the transition parameters. */
     QDomElement m_parameters;
-    /** The clip to which the transition is attached */
-    ClipItem *m_referenceClip;
 
-    /** The 2nd clip to which the transition is attached */
-    ClipItem *m_secondClip;
     int m_transitionTrack;
 
-    /** Return the display name for a transition type */
-    QString getTransitionName(const TRANSITIONTYPE & type);
+    /** @brief Returns the display name for a transition type. */
+    QString getTransitionName(const TransitionType & type);
 
-    /** Return the transition type for a given name */
-    TRANSITIONTYPE getTransitionForName(const QString & type);
+    /** @brief Returns the transition type for a given name. */
+    TransitionType getTransitionForName(const QString & type);
 };
 
 #endif