X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fkdenlivedoc.h;h=f38051a814c855c4760966ffc6bf430760542bf4;hb=787f4f5c61761da7d96b3b9143ca28a7b1dd4e5c;hp=06e4f7337614666f8d77ea1506e529ec49ea3bb2;hpb=fec4b6aba639dac658d35475512c6f232c8aebe3;p=kdenlive

diff --git a/src/kdenlivedoc.h b/src/kdenlivedoc.h
index 06e4f733..f38051a8 100644
--- a/src/kdenlivedoc.h
+++ b/src/kdenlivedoc.h
@@ -45,11 +45,14 @@ class DocClipBase;
 class MainWindow;
 class TrackInfo;
 
+class KTextEdit;
+class KProgressDialog;
+
 class KdenliveDoc: public QObject
 {
 Q_OBJECT public:
 
-    KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, const QPoint tracks, Render *render, MainWindow *parent = 0);
+    KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, QMap <QString, QString> properties, const QPoint tracks, Render *render, KTextEdit *notes, MainWindow *parent = 0, KProgressDialog *progressDialog = 0);
     ~KdenliveDoc();
     QDomNodeList producersList();
     double fps() const;
@@ -66,55 +69,94 @@ Q_OBJECT public:
     QDomDocument m_guidesXml;
     QDomElement guidesXml() const;
     ClipManager *clipManager();
-    void addClip(QDomElement elem, QString clipId, bool createClipItem = true);
-    void addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
+
+    /** @brief Adds a clip to the project tree.
+     * @return false if the user aborted the operation, true otherwise */
+    bool addClip(QDomElement elem, QString clipId, bool createClipItem = true);
+
+    /** @brief Updates information about a clip.
+     * @param elem the <kdenlive_producer />
+     * @param orig the potential <producer />
+     * @param clipId the producer id
+     * @return false if the user aborted the operation (in case the clip wasn't
+     *     there yet), true otherwise
+     *
+     * If the clip wasn't added before, it tries to add it to the project. */
+    bool addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
     void deleteClip(const QString &clipId);
     int getFramePos(QString duration);
     DocClipBase *getBaseClip(const QString &clipId);
     void updateClip(const QString id);
-    void deleteProjectClip(QStringList ids);
-    /** Inform application of the audio thumbnails generation progress */
+
+    /** @brief Informs Kdenlive of the audio thumbnails generation progress. */
     void setThumbsProgress(const QString &message, int progress);
     const QString &profilePath() const;
     MltVideoProfile mltProfile() const;
     const QString description() const;
     void setUrl(KUrl url);
-    /** update project profile, returns true if fps was changed */
+
+    /** @brief Updates the project profile.
+     * @return true if frame rate was changed */
     bool setProfilePath(QString path);
     const QString getFreeClipId();
-    /** does the document need saving */
+
+    /** @brief Defines whether the document needs to be saved. */
     bool isModified() const;
-    /** Returns project folder, used to store project files (titles, effects,...) */
+
+    /** @brief Returns the project folder, used to store project files. */
     KUrl projectFolder() const;
     void syncGuides(QList <Guide *> guides);
     void setZoom(int horizontal, int vertical);
     QPoint zoom() const;
-    double dar();
+    double dar() const;
     double projectDuration() const;
-    bool saveSceneList(const QString &path, const QString &scene);
+    bool saveSceneList(const QString &path, const QString &scene, const QStringList expandedFolders);
     int tracksCount() const;
     TrackInfo trackInfoAt(int ix) const;
     void insertTrack(int ix, TrackInfo type);
     void deleteTrack(int ix);
     void setTrackType(int ix, TrackInfo type);
     const QList <TrackInfo> tracksList() const;
+
+    /** @brief Gets the number of audio and video tracks and returns them as a QPoint with x = video, y = audio. */
     QPoint getTracksCount() const;
+
     void switchTrackVideo(int ix, bool hide);
     void switchTrackAudio(int ix, bool hide);
     void switchTrackLock(int ix, bool lock);
+    bool isTrackLocked(int ix) const;
+
+    /** @brief Sets the duration of track @param ix to @param duration.
+     * This does not! influence the actual track but only the value in its TrackInfo. */
+    void setTrackDuration(int ix, int duration);
+
+    /** @brief Returns the duration of track @param ix.
+     *
+     * The returned duration might differ from the actual track duration!
+     * It is the one stored in the track's TrackInfo. */
+    int trackDuration(int ix);
+
     void cachePixmap(const QString &fileId, const QPixmap &pix) const;
     void setProjectFolder(KUrl url);
     QString getLadspaFile() const;
     void setZone(int start, int end);
     QPoint zone() const;
     int setSceneList();
-    void updatePreviewSettings();
-    bool isTrackLocked(int ix) const;
     void setDocumentProperty(const QString &name, const QString &value);
     const QString getDocumentProperty(const QString &name) const;
 
+    /** @brief Gets the list of renderer properties saved into the document. */
+    QMap <QString, QString> getRenderProperties() const;
+    void addTrackEffect(int ix, QDomElement effect);
+    void removeTrackEffect(int ix, QDomElement effect);
+    void setTrackEffect(int trackIndex, int effectIndex, QDomElement effect);
+    const EffectsList getTrackEffects(int ix);
+    QDomElement getTrackEffect(int trackIndex, int effectIndex) const;
+    /** @brief Get a list of folder id's that were opened on last save. */
+    QStringList getExpandedFolders();
+    
 private:
     KUrl m_url;
     QDomDocument m_document;
@@ -123,16 +165,18 @@ private:
     int m_height;
     Timecode m_timecode;
     Render *m_render;
+    KTextEdit *m_notesWidget;
     QUndoStack *m_commandStack;
     ClipManager *m_clipManager;
     MltVideoProfile m_profile;
     QTimer *m_autoSaveTimer;
     QString m_searchFolder;
-    /** tells whether current doc has been changed since last save event */
+
+    /** @brief Tells whether the current document has been changed after being saved. */
     bool m_modified;
-    /** Project folder, used to store project files (titles, effects,...) */
+
+    /** @brief The project folder, used to store project files (titles, effects...). */
     KUrl m_projectFolder;
-    bool m_abortLoading;
     QMap <QString, QString> m_documentProperties;
 
     QList <TrackInfo> m_tracksList;
@@ -140,15 +184,32 @@ private:
     QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
     void moveProjectData(KUrl url);
     bool checkDocumentClips(QDomNodeList infoproducers);
+
+    /** @brief Creates a new project. */
     QDomDocument createEmptyDocument(int videotracks, int audiotracks);
     QDomDocument createEmptyDocument(QList <TrackInfo> tracks);
+    /** @brief Saves effects embedded in project file.
+    *   @return True if effects were imported.  */
+    bool saveCustomEffects(QDomNodeList customeffects);
+
+    /** @brief Updates the project folder location entry in the kdenlive file dialogs to point to the current project folder. */
+    void updateProjectFolderPlacesEntry();
 
 public slots:
+    void slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId);
     void slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId);
-    void slotCreateSlideshowClipFile(const QString name, const QString path, int count, const QString duration, const bool loop, const bool fade, const QString &luma_duration, const QString &luma_file, const int softness, QString group, const QString &groupId);
+    void slotCreateSlideshowClipFile(const QString name, const QString path,
+                                     int count, const QString duration,
+                                     const bool loop, const bool crop,
+                                     const bool fade, const QString &luma_duration,
+                                     const QString &luma_file, const int softness,
+                                     const QString &animation, QString group,
+                                     const QString &groupId);
     void slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath = QString());
     void slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path);
-    /** Set to true if document needs saving, false otherwise */
+
+    /** @brief Sets the document as modified or up to date.
+     * @param mod (optional) true if the document has to be saved */
     void setModified(bool mod = true);
     void checkProjectClips();
 
@@ -162,7 +223,10 @@ signals:
     void updateClipDisplay(const QString&);
     void deleteTimelineClip(const QString&);
     void progressInfo(const QString &, int);
-    /** emitted when the document state has been modified (= needs saving or not) */
+
+    /** @brief Informs that the document status has been changed.
+     *
+     * If the document has been modified, it's called with true as an argument. */
     void docModified(bool);
     void selectLastAddedClip(const QString &);
     void guidesUpdated();