]> git.sesse.net Git - kdenlive/blob - src/projectitem.h
Start implementing a generic clip job framework that can be used
[kdenlive] / src / projectitem.h
1 /***************************************************************************
2  *   Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
18  ***************************************************************************/
19
20
21 #ifndef PROJECTITEM_H
22 #define PROJECTITEM_H
23
24 #include <QTreeWidgetItem>
25 #include <QTreeWidget>
26 #include <QDomElement>
27 #include <QProcess>
28
29 #include <KUrl>
30
31 #include "gentime.h"
32 #include "definitions.h"
33
34 class DocClipBase;
35
36 /** \brief Represents a clip or a folder in the projecttree
37  *
38  * This class represents a clip or folder in the projecttree and in the document(?) */
39 class ProjectItem : public QTreeWidgetItem
40 {
41 public:
42     ProjectItem(QTreeWidget * parent, DocClipBase *clip);
43     ProjectItem(QTreeWidgetItem * parent, DocClipBase *clip);
44     virtual ~ProjectItem();
45     QDomElement toXml() const;
46     int numReferences() const;
47
48     void setProperties(const QMap < QString, QString > &attributes, const QMap < QString, QString > &metadata);
49
50     /** \brief The id of the clip or folder.
51      *
52      * The clipId is used both to identify clips and folders (groups) */
53     const QString &clipId() const;
54     QStringList names() const;
55     const KUrl clipUrl() const;
56     int clipMaxDuration() const;
57     CLIPTYPE clipType() const;
58     void changeDuration(int frames);
59     DocClipBase *referencedClip();
60     void setProperties(QMap <QString, QString> props);
61     void setProperty(const QString &key, const QString &value);
62     void clearProperty(const QString &key);
63     QString getClipHash() const;
64     static int itemDefaultHeight();
65     void slotSetToolTip();
66     /** \brief Set the status of proxy clip creation. 0 = no proxy, 1 = creating proxy, 2 = proxy created. */
67     void setProxyStatus(CLIPJOBSTATUS status, int progress = 0);
68     /** \brief Returns the proxy status for this clip (true means there is a proxy clip). */
69     bool hasProxy() const;
70     /** \brief Returns true if the proxy for this clip is ready. */
71     bool isProxyReady() const;
72     /** \brief Returns true if we are currently creating the proxy for this clip. */
73     bool isProxyRunning() const;
74
75     virtual bool operator<(const QTreeWidgetItem &other)const {
76         int column = treeWidget()->sortColumn();
77         if (other.type() != PROJECTFOLDERTYPE)
78             return text(column).toLower() < other.text(column).toLower();
79         else return false;
80     }
81
82 private:
83     CLIPTYPE m_clipType;
84     DocClipBase *m_clip;
85     QString m_clipId;
86     /** @brief Setup basic properties */
87     void buildItem();
88     /** @brief Check if an xml project file has proxies */
89     bool playlistHasProxies(const QString path);
90 };
91
92 #endif