]> git.sesse.net Git - kdenlive/blob - src/projectitem.h
Cleaning code style of Definitions.
[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 #include "projecttree/abstractclipjob.h"
34
35
36 class DocClipBase;
37
38 /** \brief Represents a clip or a folder in the projecttree
39  *
40  * This class represents a clip or folder in the projecttree and in the document(?) */
41 class ProjectItem : public QTreeWidgetItem
42 {
43 public:
44     ProjectItem(QTreeWidget * parent, DocClipBase *clip, const QSize &pixmapSize);
45     ProjectItem(QTreeWidgetItem * parent, DocClipBase *clip, const QSize &pixmapSize);
46     virtual ~ProjectItem();
47     QDomElement toXml() const;
48     int numReferences() const;
49
50     void setProperties(const QMap < QString, QString > &attributes, const QMap < QString, QString > &metadata);
51
52     /** \brief The id of the clip or folder.
53      *
54      * The clipId is used both to identify clips and folders (groups) */
55     const QString &clipId() const;
56     const KUrl clipUrl() const;
57     int clipMaxDuration() const;
58     ClipType clipType() const;
59     void changeDuration(int frames);
60     DocClipBase *referencedClip();
61     void setProperties(const QMap <QString, QString> &props);
62     void setProperty(const QString &key, const QString &value);
63     void clearProperty(const QString &key);
64     QString getClipHash() const;
65     static int itemDefaultHeight();
66     void slotSetToolTip();
67     /** \brief Set the status of the clip job. */
68     void setJobStatus(JOBTYPE jobType, ClipJobStatus status, int progress = 0, const QString &statusMessage = QString());
69     /** \brief Set the status of a clip job if it is of the specified job type. */
70     void setConditionalJobStatus(ClipJobStatus status, JOBTYPE requestedJobType);
71     /** \brief Returns the proxy status for this clip (true means there is a proxy clip). */
72     bool hasProxy() const;
73     /** \brief Returns true if the proxy for this clip is ready. */
74     bool isProxyReady() const;
75     /** \brief Returns true if there is a job currently running for this clip. */
76     bool isJobRunning() const;
77     /** \brief Returns true if we are currently creating the proxy for this clip. */
78     bool isProxyRunning() const;
79     /** \brief Returns true if the thumbnail for this clip has been loaded. */
80     bool hasPixmap() const;
81     /** \brief Sets the thumbnail for this clip. */
82     void setPixmap(const QPixmap& p);
83
84     virtual bool operator<(const QTreeWidgetItem &other)const {
85         int column = treeWidget()->sortColumn();
86         if (other.type() != ProjectFoldeType)
87             return text(column).toLower() < other.text(column).toLower();
88         else return false;
89     }
90
91 private:
92     ClipType m_clipType;
93     DocClipBase *m_clip;
94     QString m_clipId;
95     bool m_pixmapSet;
96     /** @brief Setup basic properties */
97     void buildItem(const QSize &pixmapSize);
98     /** @brief Check if an xml project file has proxies */
99     bool playlistHasProxies(const QString& path);
100 };
101
102 #endif