X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Feffectslist.h;h=a12a36f4d9943f2beaeec76d5d123ed2f4585b12;hb=a1bec067bd32e1b489c8be5d3968b45b4645d659;hp=220174f06a6a5a7e048279ad47087f0e5bec567d;hpb=1bb5954abb1179a8cd75a3dbffec0911f297357e;p=kdenlive

diff --git a/src/effectslist.h b/src/effectslist.h
index 220174f0..a12a36f4 100644
--- a/src/effectslist.h
+++ b/src/effectslist.h
@@ -15,29 +15,46 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+ * @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 <QDomDocument>
 
-/**A 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
-  */
-
-
 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;
@@ -52,10 +69,17 @@ public:
     void replace(int ix, QDomElement effect);
     static bool hasKeyFrames(QDomElement effect);
     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: