X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Feffectslist.h;h=a12a36f4d9943f2beaeec76d5d123ed2f4585b12;hb=ecda842bf2b632f75198d6cf0fac1fcb5ef862ad;hp=fe36a0c37a196cb6ac6013a0d450726487cfa4fa;hpb=d528ca2899eeefa3abc20d87d874d12b1b7815eb;p=kdenlive

diff --git a/src/effectslist.h b/src/effectslist.h
index fe36a0c3..a12a36f4 100644
--- a/src/effectslist.h
+++ b/src/effectslist.h
@@ -1,5 +1,5 @@
 /***************************************************************************
-                          docclipbaseiterator.h  -  description
+                          effectslist.h  -  description
                              -------------------
     begin                : Sat Aug 10 2002
     copyright            : (C) 2002 by Jason Wood
@@ -15,36 +15,76 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+ * @class EffectsList
+ * @brief List for effects objects.
+ * @author Jason Wood
+ *
+ * This is a list of DocClipBase objects, to be used instead of
+ * QList<DocClipBase> to enable sorting lists correctly. It also contains the
+ * ability to set a "master clip", which can be used by a number of operations
+ * where there is the need of one clip to act as a reference for what happens to
+ * all clips.
+ */
+
 #ifndef EFFECTSLIST_H
 #define EFFECTSLIST_H
 
-#include <QList>
-
-/**An List for DocClipBase objects. Use this instead of QList<DocClipBase> so as to sort lists correctly.
- * Also contains the ability to set a "master clip", which can be used by a number of operations where
- * the need for one clip to act as a reference for what happens to all clips is needed.
-  * @author Jason Wood
-  */
-
-#include <QDomElement>
+#include <QDomDocument>
 
-class EffectsList: public QList < QDomElement > {
+class EffectsList: public QDomDocument
+{
 public:
     EffectsList();
     ~EffectsList();
-    /** Returns an XML version of this Effect.*/
+
+    /** @brief Returns the XML element of an effect.
+     * @param name name of the effect to be returned */
     QDomElement getEffectByName(const QString & name) const;
     QDomElement getEffectByTag(const QString & tag, const QString & id) const;
-    /** if the list contains effect defined by tag + id, returns effect index, otherwise -1 */
+
+    /** @brief Checks the existance of an effect.
+     * @param tag effect tag
+     * @param id effect id
+     * @return effect index if the effect exists, -1 otherwise */
     int hasEffect(const QString & tag, const QString & id) const;
+
+    /** @brief Lists the core properties of an effect.
+     * @param ix effect index
+     * @return list of name, tag and id of an effect */
     QStringList effectIdInfo(const int ix) const;
+
+    /** @brief Lists effects names. */
     QStringList effectNames();
     QString getInfo(const QString & tag, const QString & id) const;
     QString getInfoFromIndex(const int ix) const;
-    QMap <QString, QString> effect(const QString & name);
-    EffectsList clone() const;
+    void clone(const EffectsList original);
+    void append(QDomElement e);
+    bool isEmpty() const;
+    int count() const;
+    const QDomElement at(int ix) const;
+    void removeAt(int ix);
+    QDomElement item(int ix);
+    void insert(int ix, QDomElement effect);
+    void replace(int ix, QDomElement effect);
     static bool hasKeyFrames(QDomElement effect);
-    static void setParameter(QDomElement effect, QString name, QString value);
+    static bool hasSimpleKeyFrames(QDomElement effect);
+    static bool hasGeometryKeyFrames(QDomElement effect);
+    static void setParameter(QDomElement effect, const QString &name, const QString &value);
+    static QString parameter(QDomElement effect, const QString &name);
+    /** @brief Change the value of a 'property' element from the effect node. */
+    static void setProperty(QDomElement effect, const QString &name, const QString &value);
+    /** @brief Rename a 'property' element from the effect node. */
+    static void renameProperty(QDomElement effect, const QString &oldName, const QString &newName);
+    /** @brief Get the value of a 'property' element from the effect node. */
+    static QString property(QDomElement effect, const QString &name);
+    /** @brief Delete a 'property' element from the effect node. */
+    static void removeProperty(QDomElement effect, const QString &name);
+    void clearList();
+
+private:
+    QDomElement m_baseElement;
+
 };
 
 #endif