]> git.sesse.net Git - kdenlive/blobdiff - src/docclipbase.h
Reindent all source files
[kdenlive] / src / docclipbase.h
index c91934f4c67cdf520ef7b9c929df58a58b475f46..0c42233220a5ac7395c20a211d01acc7cdf1c8ab 100644 (file)
@@ -33,7 +33,7 @@
 #include "gentime.h"
 #include "clipmanager.h"
 #include "definitions.h"
- #include "kthumb.h"
+#include "kthumb.h"
 
 /*
 class DocTrackBase;
@@ -43,208 +43,212 @@ class DocClipVirtual;
 class EffectDescriptionList;*/
 class KdenliveDoc;
 
-class CommentedTime
-    {
-    public:
-        CommentedTime(): t(GenTime(0)) {}
-        CommentedTime( const GenTime time, QString comment)
-            : t( time ), c( comment )
-        { }
-
-        QString comment()   const          { return (c.isEmpty() ? i18n("Marker") : c);}
-        GenTime time() const          { return t; }
-        void    setComment( QString comm) { c = comm; }
-    private:
-        GenTime t;
-        QString c;
-    };
-
-
-class DocClipBase:public QObject {
-  Q_OBJECT public:
-       /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
-        * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
-        *   done here. If a new clip type is added then it should be possible to combine it with both audio
-        *   and video. */
-
-     DocClipBase(ClipManager *clipManager, QDomElement xml, uint id);
-     DocClipBase(const DocClipBase& clip);
-     DocClipBase & operator=(const DocClipBase & clip);
-     virtual ~ DocClipBase();
-
-       /** sets the name of this clip. */
+class CommentedTime {
+public:
+    CommentedTime(): t(GenTime(0)) {}
+    CommentedTime(const GenTime time, QString comment)
+            : t(time), c(comment) { }
+
+    QString comment()   const          {
+        return (c.isEmpty() ? i18n("Marker") : c);
+    }
+    GenTime time() const          {
+        return t;
+    }
+    void    setComment(QString comm) {
+        c = comm;
+    }
+private:
+    GenTime t;
+    QString c;
+};
+
+
+class DocClipBase: public QObject {
+Q_OBJECT public:
+    /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
+     * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
+     *   done here. If a new clip type is added then it should be possible to combine it with both audio
+     *   and video. */
+
+    DocClipBase(ClipManager *clipManager, QDomElement xml, uint id);
+    DocClipBase(const DocClipBase& clip);
+    DocClipBase & operator=(const DocClipBase & clip);
+    virtual ~ DocClipBase();
+
+    /** sets the name of this clip. */
     void setName(const QString name);
 
-       /** returns the name of this clip. */
+    /** returns the name of this clip. */
     const QString & name() const;
 
-       /** Sets the description for this clip. */
+    /** Sets the description for this clip. */
     void setDescription(const QString & descripton);
 
-       /** Returns the description of this clip. */
+    /** Returns the description of this clip. */
     const QString & description() const;
 
     /** Returns the internal unique id of the clip. */
     uint getId() const;
-    void setId( const uint &newId);
+    void setId(const uint &newId);
 
     //KThumb *thumbCreator;
     bool audioThumbCreated() const;
-    
-       /** returns the duration of this clip */
+
+    /** returns the duration of this clip */
     const GenTime & duration() const;
-       /** returns the duration of this clip */
+    /** returns the duration of this clip */
     void setDuration(GenTime dur);
 
-       /** returns clip type (audio, text, image,...) */
+    /** returns clip type (audio, text, image,...) */
     const CLIPTYPE & clipType() const;
-       /** set clip type (audio, text, image,...) */
+    /** set clip type (audio, text, image,...) */
     void setClipType(CLIPTYPE type);
 
-       /** remove tmp file if the clip has one (for example text clips) */
+    /** remove tmp file if the clip has one (for example text clips) */
     void removeTmpFile() const;
 
-       /** Returns a url to a file describing this clip. Exactly what this url is,
-       whether it is temporary or not, and whether it provokes a render will
-       depend entirely on what the clip consists of. */
+    /** Returns a url to a file describing this clip. Exactly what this url is,
+    whether it is temporary or not, and whether it provokes a render will
+    depend entirely on what the clip consists of. */
     KUrl fileURL() const;
 
-       /** Returns true if the clip duration is known, false otherwise. */
+    /** Returns true if the clip duration is known, false otherwise. */
     bool durationKnown() const;
     // Returns the number of frames per second that this clip should play at.
     double framesPerSecond() const;
 
     bool isDocClipAVFile() const {
-       return false;
-    } 
-    
+        return false;
+    }
+
     /*virtual DocClipAVFile *toDocClipAVFile() {
-       return 0;
+    return 0;
     }
 
     virtual DocClipTextFile *toDocClipTextFile() {
         return 0;
     }
-    
+
     virtual bool isDocClipTextFile() const {
         return false;
     }
 
     virtual bool isDocClipVirtual() const {
         return false;
-    } 
-    
+    }
+
     virtual DocClipVirtual *toDocClipVirtual() {
         return 0;
     }*/
-    
-       /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
-        * where it returns true. */ 
+
+    /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
+     * where it returns true. */
     bool isProjectClip() const {
-       return false;
+        return false;
     }
     // Appends scene times for this clip to the passed vector.
-/*     virtual void populateSceneTimes(QList < GenTime >
-       &toPopulate) const = 0;*/
+    /* virtual void populateSceneTimes(QList < GenTime >
+     &toPopulate) const = 0;*/
 
-       /** Reads in the element structure and creates a clip out of it.*/
+    /** Reads in the element structure and creates a clip out of it.*/
     // Returns an XML document that describes part of the current scene.
     QDomDocument sceneToXML(const GenTime & startTime,
-       const GenTime & endTime) const;
-       /** returns a QString containing all of the XML data required to recreate this clip. */
+                            const GenTime & endTime) const;
+    /** returns a QString containing all of the XML data required to recreate this clip. */
     QDomElement toXML() const;
     QDomDocument generateSceneList(bool addProducers = true, bool rendering = false) const;
 
-       /** Returns true if the xml passed matches the values in this clip */
+    /** Returns true if the xml passed matches the values in this clip */
     bool matchesXML(const QDomElement & element) const;
 
     void addReference() {
-       ++m_refcount;
+        ++m_refcount;
     }
     void removeReference() {
-       --m_refcount;
+        --m_refcount;
     }
     uint numReferences() const {
-       return m_refcount;
+        return m_refcount;
     }
-       /** Returns true if this clip has a meaningful filesize. */
-       bool hasFileSize() const;
+    /** Returns true if this clip has a meaningful filesize. */
+    bool hasFileSize() const;
 
-       /** Returns the filesize, or 0 if there is no appropriate filesize. */
+    /** Returns the filesize, or 0 if there is no appropriate filesize. */
     uint fileSize() const;
 
-       /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
-        * it uses it as part of it's own composition. */
+    /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
+     * it uses it as part of it's own composition. */
     bool referencesClip(DocClipBase * clip) const;
 
-       /** Sets the thumbnail to be used by this clip */
+    /** Sets the thumbnail to be used by this clip */
     void setThumbnail(const QPixmap & pixmap);
 
-       /** Returns the thumbnail producer used by this clip */
+    /** Returns the thumbnail producer used by this clip */
     KThumb *thumbProducer();
 
-       /** Returns the thumbnail used by this clip */
+    /** Returns the thumbnail used by this clip */
     const QPixmap & thumbnail() const;
 
     static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
     /** Cache for every audio Frame with 10 Bytes */
     /** format is frame -> channel ->bytes */
-    QMap<int,QMap<int,QByteArray> > audioFrameChache;
+    QMap<int, QMap<int, QByteArray> > audioFrameChache;
 
-       /** return english name for clip type */
+    /** return english name for clip type */
     static QString getTypeName(CLIPTYPE type);
 
-      /** Clip is ready to get thumbs */ 
+    /** Clip is ready to get thumbs */
     void slotRequestAudioThumbs();
 
 
-  private:                     // Private attributes
-       /** The name of this clip */
+private:   // Private attributes
+    /** The name of this clip */
     QString m_name;
-       /** A description of this clip */
+    /** A description of this clip */
     QString m_description;
-       /** The number of times this clip is used in the project - the number of references to this clip
-        * that exist. */
+    /** The number of times this clip is used in the project - the number of references to this clip
+     * that exist. */
     uint m_refcount;
 
     CLIPTYPE m_clipType;
 
-       /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
+    /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
     QList < CommentedTime > m_snapMarkers;
     QDomElement m_xml;
 
-       /** A thumbnail for this clip */
+    /** A thumbnail for this clip */
     QPixmap m_thumbnail;
     GenTime m_duration;
 
     QTimer *m_audioTimer;
     KThumb *m_thumbProd;
     bool m_audioThumbCreated;
-    
+
     /** a unique numeric id */
     uint m_id;
     uint m_projectThumbFrame;
     void setAudioThumbCreated(bool isDone);
-       
-  public slots:
-       void updateAudioThumbnail(QMap<int,QMap<int,QByteArray> > data);
-       void slotGetAudioThumbs();
-       QList < CommentedTime > commentedSnapMarkers() const;
-       void setSnapMarkers(QList < CommentedTime > markers);
-       GenTime findNextSnapMarker(const GenTime & currTime);
-       GenTime findPreviousSnapMarker(const GenTime & currTime);
-       GenTime hasSnapMarkers(const GenTime & time);
-       QString deleteSnapMarker(const GenTime & time);
-       void editSnapMarker(const GenTime & time, QString comment);
-       void addSnapMarker(const GenTime & time, QString comment);
-       QList < GenTime > snapMarkers() const;
-       QString markerComment(GenTime t);
-       void setProjectThumbFrame( const uint &ix);
-       uint getProjectThumbFrame() const;
-
-  signals:
-       void getAudioThumbs();
-       void gotAudioData();
+
+public slots:
+    void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
+    void slotGetAudioThumbs();
+    QList < CommentedTime > commentedSnapMarkers() const;
+    void setSnapMarkers(QList < CommentedTime > markers);
+    GenTime findNextSnapMarker(const GenTime & currTime);
+    GenTime findPreviousSnapMarker(const GenTime & currTime);
+    GenTime hasSnapMarkers(const GenTime & time);
+    QString deleteSnapMarker(const GenTime & time);
+    void editSnapMarker(const GenTime & time, QString comment);
+    void addSnapMarker(const GenTime & time, QString comment);
+    QList < GenTime > snapMarkers() const;
+    QString markerComment(GenTime t);
+    void setProjectThumbFrame(const uint &ix);
+    uint getProjectThumbFrame() const;
+
+signals:
+    void getAudioThumbs();
+    void gotAudioData();
 };
 
 #endif